Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. StorageFile
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.StorageFile

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Create, delete, and update a file storage resource. This allows NFS-based Endurance and Performance file storage.

    File storage is mounted by using the NFS protocol. For example, a file storage resource with the hostname argument set to nfsdal0501a.service.softlayer.com and the volumename argument set to IBM01SV278685_7 has the mount point nfsdal0501a.service.softlayer.com:-IBM01SV278685_7.

    For more information, see getting started with File Storage for NFS configuration.

    Example Usage

    In the following example, you can create 20G of Endurance file storage with a 10G snapshot capacity and 0.25 IOPS/GB.

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const fsEndurance = new ibm.StorageFile("fsEndurance", {
    allowedIpAddresses: ["10.146.139.84"],
    allowedSubnets: ["10.146.139.64/26"],
    allowedVirtualGuestIds: [28961689],
    capacity: 20,
    datacenter: "dal06",
    hourlyBilling: true,
    iops: 0.25,
    snapshotCapacity: 10,
    snapshotSchedules: [
        {
            dayOfWeek: "SUNDAY",
            enable: true,
            hour: 13,
            minute: 2,
            retentionCount: 20,
            scheduleType: "WEEKLY",
        },
        {
            enable: true,
            minute: 2,
            retentionCount: 20,
            scheduleType: "HOURLY",
        },
    ],
    type: "Endurance",
});

    import pulumi
import pulumi_ibm as ibm

fs_endurance = ibm.StorageFile("fsEndurance",
    allowed_ip_addresses=["10.146.139.84"],
    allowed_subnets=["10.146.139.64/26"],
    allowed_virtual_guest_ids=[28961689],
    capacity=20,
    datacenter="dal06",
    hourly_billing=True,
    iops=0.25,
    snapshot_capacity=10,
    snapshot_schedules=[
        {
            "day_of_week": "SUNDAY",
            "enable": True,
            "hour": 13,
            "minute": 2,
            "retention_count": 20,
            "schedule_type": "WEEKLY",
        },
        {
            "enable": True,
            "minute": 2,
            "retention_count": 20,
            "schedule_type": "HOURLY",
        },
    ],
    type="Endurance")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewStorageFile(ctx, "fsEndurance", &ibm.StorageFileArgs{
			AllowedIpAddresses: pulumi.StringArray{
				pulumi.String("10.146.139.84"),
			},
			AllowedSubnets: pulumi.StringArray{
				pulumi.String("10.146.139.64/26"),
			},
			AllowedVirtualGuestIds: pulumi.Float64Array{
				pulumi.Float64(28961689),
			},
			Capacity:         pulumi.Float64(20),
			Datacenter:       pulumi.String("dal06"),
			HourlyBilling:    pulumi.Bool(true),
			Iops:             pulumi.Float64(0.25),
			SnapshotCapacity: pulumi.Float64(10),
			SnapshotSchedules: ibm.StorageFileSnapshotScheduleArray{
				&ibm.StorageFileSnapshotScheduleArgs{
					DayOfWeek:      pulumi.String("SUNDAY"),
					Enable:         pulumi.Bool(true),
					Hour:           pulumi.Float64(13),
					Minute:         pulumi.Float64(2),
					RetentionCount: pulumi.Float64(20),
					ScheduleType:   pulumi.String("WEEKLY"),
				},
				&ibm.StorageFileSnapshotScheduleArgs{
					Enable:         pulumi.Bool(true),
					Minute:         pulumi.Float64(2),
					RetentionCount: pulumi.Float64(20),
					ScheduleType:   pulumi.String("HOURLY"),
				},
			},
			Type: pulumi.String("Endurance"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var fsEndurance = new Ibm.StorageFile("fsEndurance", new()
    {
        AllowedIpAddresses = new[]
        {
            "10.146.139.84",
        },
        AllowedSubnets = new[]
        {
            "10.146.139.64/26",
        },
        AllowedVirtualGuestIds = new[]
        {
            28961689,
        },
        Capacity = 20,
        Datacenter = "dal06",
        HourlyBilling = true,
        Iops = 0.25,
        SnapshotCapacity = 10,
        SnapshotSchedules = new[]
        {
            new Ibm.Inputs.StorageFileSnapshotScheduleArgs
            {
                DayOfWeek = "SUNDAY",
                Enable = true,
                Hour = 13,
                Minute = 2,
                RetentionCount = 20,
                ScheduleType = "WEEKLY",
            },
            new Ibm.Inputs.StorageFileSnapshotScheduleArgs
            {
                Enable = true,
                Minute = 2,
                RetentionCount = 20,
                ScheduleType = "HOURLY",
            },
        },
        Type = "Endurance",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.StorageFile;
import com.pulumi.ibm.StorageFileArgs;
import com.pulumi.ibm.inputs.StorageFileSnapshotScheduleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var fsEndurance = new StorageFile("fsEndurance", StorageFileArgs.builder()
            .allowedIpAddresses("10.146.139.84")
            .allowedSubnets("10.146.139.64/26")
            .allowedVirtualGuestIds("28961689")
            .capacity(20)
            .datacenter("dal06")
            .hourlyBilling(true)
            .iops(0.25)
            .snapshotCapacity(10)
            .snapshotSchedules(            
                StorageFileSnapshotScheduleArgs.builder()
                    .dayOfWeek("SUNDAY")
                    .enable(true)
                    .hour(13)
                    .minute(2)
                    .retentionCount(20)
                    .scheduleType("WEEKLY")
                    .build(),
                StorageFileSnapshotScheduleArgs.builder()
                    .enable(true)
                    .minute(2)
                    .retentionCount(20)
                    .scheduleType("HOURLY")
                    .build())
            .type("Endurance")
            .build());

    }
}

    resources:
  fsEndurance:
    type: ibm:StorageFile
    properties:
      allowedIpAddresses:
        - 10.146.139.84
      allowedSubnets:
        - 10.146.139.64/26
      # Optional fields
      allowedVirtualGuestIds:
        - '28961689'
      capacity: 20
      datacenter: dal06
      hourlyBilling: true
      iops: 0.25
      snapshotCapacity: 10
      snapshotSchedules:
        - dayOfWeek: SUNDAY
          enable: true
          hour: 13
          minute: 2
          retentionCount: 20
          scheduleType: WEEKLY
        - enable: true
          minute: 2
          retentionCount: 20
          scheduleType: HOURLY
      type: Endurance

    In the following example, you can create 20G of Performance file storage with 100 IOPS.

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const fsPerformance = new ibm.StorageFile("fsPerformance", {
    allowedIpAddresses: ["10.146.139.84"],
    allowedSubnets: ["10.146.139.64/26"],
    allowedVirtualGuestIds: [28961689],
    capacity: 20,
    datacenter: "dal06",
    hourlyBilling: true,
    iops: 100,
    type: "Performance",
});

    import pulumi
import pulumi_ibm as ibm

fs_performance = ibm.StorageFile("fsPerformance",
    allowed_ip_addresses=["10.146.139.84"],
    allowed_subnets=["10.146.139.64/26"],
    allowed_virtual_guest_ids=[28961689],
    capacity=20,
    datacenter="dal06",
    hourly_billing=True,
    iops=100,
    type="Performance")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewStorageFile(ctx, "fsPerformance", &ibm.StorageFileArgs{
			AllowedIpAddresses: pulumi.StringArray{
				pulumi.String("10.146.139.84"),
			},
			AllowedSubnets: pulumi.StringArray{
				pulumi.String("10.146.139.64/26"),
			},
			AllowedVirtualGuestIds: pulumi.Float64Array{
				pulumi.Float64(28961689),
			},
			Capacity:      pulumi.Float64(20),
			Datacenter:    pulumi.String("dal06"),
			HourlyBilling: pulumi.Bool(true),
			Iops:          pulumi.Float64(100),
			Type:          pulumi.String("Performance"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var fsPerformance = new Ibm.StorageFile("fsPerformance", new()
    {
        AllowedIpAddresses = new[]
        {
            "10.146.139.84",
        },
        AllowedSubnets = new[]
        {
            "10.146.139.64/26",
        },
        AllowedVirtualGuestIds = new[]
        {
            28961689,
        },
        Capacity = 20,
        Datacenter = "dal06",
        HourlyBilling = true,
        Iops = 100,
        Type = "Performance",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.StorageFile;
import com.pulumi.ibm.StorageFileArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var fsPerformance = new StorageFile("fsPerformance", StorageFileArgs.builder()
            .allowedIpAddresses("10.146.139.84")
            .allowedSubnets("10.146.139.64/26")
            .allowedVirtualGuestIds("28961689")
            .capacity(20)
            .datacenter("dal06")
            .hourlyBilling(true)
            .iops(100)
            .type("Performance")
            .build());

    }
}

    resources:
  fsPerformance:
    type: ibm:StorageFile
    properties:
      allowedIpAddresses:
        - 10.146.139.84
      allowedSubnets:
        - 10.146.139.64/26
      # Optional fields
      allowedVirtualGuestIds:
        - '28961689'
      capacity: 20
      datacenter: dal06
      hourlyBilling: true
      iops: 100
      type: Performance

    Create StorageFile Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new StorageFile(name: string, args: StorageFileArgs, opts?: CustomResourceOptions);
    @overload
def StorageFile(resource_name: str,
                args: StorageFileArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def StorageFile(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                capacity: Optional[float] = None,
                type: Optional[str] = None,
                iops: Optional[float] = None,
                datacenter: Optional[str] = None,
                hourly_billing: Optional[bool] = None,
                allowed_virtual_guest_ids: Optional[Sequence[float]] = None,
                allowed_hardware_ids: Optional[Sequence[float]] = None,
                allowed_subnets: Optional[Sequence[str]] = None,
                notes: Optional[str] = None,
                snapshot_capacity: Optional[float] = None,
                snapshot_schedules: Optional[Sequence[StorageFileSnapshotScheduleArgs]] = None,
                storage_file_id: Optional[str] = None,
                tags: Optional[Sequence[str]] = None,
                timeouts: Optional[StorageFileTimeoutsArgs] = None,
                allowed_ip_addresses: Optional[Sequence[str]] = None)
    func NewStorageFile(ctx *Context, name string, args StorageFileArgs, opts ...ResourceOption) (*StorageFile, error)
    public StorageFile(string name, StorageFileArgs args, CustomResourceOptions? opts = null)
    public StorageFile(String name, StorageFileArgs args)
public StorageFile(String name, StorageFileArgs args, CustomResourceOptions options)

    type: ibm:StorageFile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args StorageFileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StorageFileArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StorageFileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StorageFileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StorageFileArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var storageFileResource = new Ibm.StorageFile("storageFileResource", new()
{
    Capacity = 0,
    Type = "string",
    Iops = 0,
    Datacenter = "string",
    HourlyBilling = false,
    AllowedVirtualGuestIds = new[]
    {
        0,
    },
    AllowedHardwareIds = new[]
    {
        0,
    },
    AllowedSubnets = new[]
    {
        "string",
    },
    Notes = "string",
    SnapshotCapacity = 0,
    SnapshotSchedules = new[]
    {
        new Ibm.Inputs.StorageFileSnapshotScheduleArgs
        {
            RetentionCount = 0,
            ScheduleType = "string",
            DayOfWeek = "string",
            Enable = false,
            Hour = 0,
            Minute = 0,
        },
    },
    StorageFileId = "string",
    Tags = new[]
    {
        "string",
    },
    Timeouts = new Ibm.Inputs.StorageFileTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    AllowedIpAddresses = new[]
    {
        "string",
    },
});

    example, err := ibm.NewStorageFile(ctx, "storageFileResource", &ibm.StorageFileArgs{
	Capacity:      pulumi.Float64(0),
	Type:          pulumi.String("string"),
	Iops:          pulumi.Float64(0),
	Datacenter:    pulumi.String("string"),
	HourlyBilling: pulumi.Bool(false),
	AllowedVirtualGuestIds: pulumi.Float64Array{
		pulumi.Float64(0),
	},
	AllowedHardwareIds: pulumi.Float64Array{
		pulumi.Float64(0),
	},
	AllowedSubnets: pulumi.StringArray{
		pulumi.String("string"),
	},
	Notes:            pulumi.String("string"),
	SnapshotCapacity: pulumi.Float64(0),
	SnapshotSchedules: ibm.StorageFileSnapshotScheduleArray{
		&ibm.StorageFileSnapshotScheduleArgs{
			RetentionCount: pulumi.Float64(0),
			ScheduleType:   pulumi.String("string"),
			DayOfWeek:      pulumi.String("string"),
			Enable:         pulumi.Bool(false),
			Hour:           pulumi.Float64(0),
			Minute:         pulumi.Float64(0),
		},
	},
	StorageFileId: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timeouts: &ibm.StorageFileTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	AllowedIpAddresses: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var storageFileResource = new StorageFile("storageFileResource", StorageFileArgs.builder()
    .capacity(0)
    .type("string")
    .iops(0)
    .datacenter("string")
    .hourlyBilling(false)
    .allowedVirtualGuestIds(0)
    .allowedHardwareIds(0)
    .allowedSubnets("string")
    .notes("string")
    .snapshotCapacity(0)
    .snapshotSchedules(StorageFileSnapshotScheduleArgs.builder()
        .retentionCount(0)
        .scheduleType("string")
        .dayOfWeek("string")
        .enable(false)
        .hour(0)
        .minute(0)
        .build())
    .storageFileId("string")
    .tags("string")
    .timeouts(StorageFileTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .allowedIpAddresses("string")
    .build());

    storage_file_resource = ibm.StorageFile("storageFileResource",
    capacity=0,
    type="string",
    iops=0,
    datacenter="string",
    hourly_billing=False,
    allowed_virtual_guest_ids=[0],
    allowed_hardware_ids=[0],
    allowed_subnets=["string"],
    notes="string",
    snapshot_capacity=0,
    snapshot_schedules=[{
        "retention_count": 0,
        "schedule_type": "string",
        "day_of_week": "string",
        "enable": False,
        "hour": 0,
        "minute": 0,
    }],
    storage_file_id="string",
    tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    allowed_ip_addresses=["string"])

    const storageFileResource = new ibm.StorageFile("storageFileResource", {
    capacity: 0,
    type: "string",
    iops: 0,
    datacenter: "string",
    hourlyBilling: false,
    allowedVirtualGuestIds: [0],
    allowedHardwareIds: [0],
    allowedSubnets: ["string"],
    notes: "string",
    snapshotCapacity: 0,
    snapshotSchedules: [{
        retentionCount: 0,
        scheduleType: "string",
        dayOfWeek: "string",
        enable: false,
        hour: 0,
        minute: 0,
    }],
    storageFileId: "string",
    tags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    allowedIpAddresses: ["string"],
});

    type: ibm:StorageFile
properties:
    allowedHardwareIds:
        - 0
    allowedIpAddresses:
        - string
    allowedSubnets:
        - string
    allowedVirtualGuestIds:
        - 0
    capacity: 0
    datacenter: string
    hourlyBilling: false
    iops: 0
    notes: string
    snapshotCapacity: 0
    snapshotSchedules:
        - dayOfWeek: string
          enable: false
          hour: 0
          minute: 0
          retentionCount: 0
          scheduleType: string
    storageFileId: string
    tags:
        - string
    timeouts:
        create: string
        delete: string
        update: string
    type: string

    StorageFile Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The StorageFile resource accepts the following input properties:

    Capacity double
    The amount of storage capacity that you want to allocate, expressed in gigabytes.
    Datacenter string
    The data center where you want to provision the file storage instance.
    Iops double
    The IOPS value for the storage instance. For supported values, see provisioning considerations.
    Type string
    The type of the storage. Accepted values are Endurance and Performance.
    AllowedHardwareIds List<double>
    The Bare Metal servers that you want to give access to this instance. Bare Metal servers must be in the same data center as the block storage. You can also use this field to import the list of Bare Metal servers that have access to this storage from the block_storage_ids argument in the ibm.ComputeBareMetal resource.
    AllowedIpAddresses List<string>
    The IP addresses that you want to allow. IP addresses must be in the same data center as the block storage.
    AllowedSubnets List<string>
    The subnets that you want to give access to this instance. Subnets must be in the same data center as the block storage.
    AllowedVirtualGuestIds List<double>
    The virtual guests that you want to give access to this instance. Virtual guests must be in the same data center as the block storage. You can also use this field to import the list of virtual guests that have access to this storage from the block_storage_ids argument in the ibm.ComputeVmInstance resource.
    HourlyBilling bool
    Set true to enable hourly billing. Default is false. Note Hourly billing is only available in updated data centers with improved capabilities. Refer to the file storage locations to get the updated list of data centers.
    Notes string
    Descriptive text to associate with the file storage.
    SnapshotCapacity double
    The amount of snapshot capacity that you want to allocate, expressed in gigabytes.
    SnapshotSchedules List<StorageFileSnapshotSchedule>
    Applies only to Endurance storage. Specifies the parameters required for a snapshot schedule.

    • snapshot_schedule.schedule_type - (Optional, String) The snapshot schedule type. Accepted values are HOURLY, WEEKLY, and DAILY.
    • snapshot_schedule.retention_count - (Optional, Integer) The retention count for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.minute - (Optional, Integer)The minute for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.hour - (Optional, Integer)The hour for a snapshot schedule. Required if schedule_type is set to DAILY or WEEKLY.
    • snapshot_schedule.day_of_week - (Optional, String) The day of the week for a snapshot schedule. Required if the schedule_type is set to WEEKLY.
    • snapshot_schedule.enable - (Optional, Bool) Whether to disable an existing snapshot schedule.
    StorageFileId string
    (String) The unique identifier of the storage volume.
    Tags List<string>
    Tags associated with the file storage instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    Timeouts StorageFileTimeouts
    Capacity float64
    The amount of storage capacity that you want to allocate, expressed in gigabytes.
    Datacenter string
    The data center where you want to provision the file storage instance.
    Iops float64
    The IOPS value for the storage instance. For supported values, see provisioning considerations.
    Type string
    The type of the storage. Accepted values are Endurance and Performance.
    AllowedHardwareIds []float64
    The Bare Metal servers that you want to give access to this instance. Bare Metal servers must be in the same data center as the block storage. You can also use this field to import the list of Bare Metal servers that have access to this storage from the block_storage_ids argument in the ibm.ComputeBareMetal resource.
    AllowedIpAddresses []string
    The IP addresses that you want to allow. IP addresses must be in the same data center as the block storage.
    AllowedSubnets []string
    The subnets that you want to give access to this instance. Subnets must be in the same data center as the block storage.
    AllowedVirtualGuestIds []float64
    The virtual guests that you want to give access to this instance. Virtual guests must be in the same data center as the block storage. You can also use this field to import the list of virtual guests that have access to this storage from the block_storage_ids argument in the ibm.ComputeVmInstance resource.
    HourlyBilling bool
    Set true to enable hourly billing. Default is false. Note Hourly billing is only available in updated data centers with improved capabilities. Refer to the file storage locations to get the updated list of data centers.
    Notes string
    Descriptive text to associate with the file storage.
    SnapshotCapacity float64
    The amount of snapshot capacity that you want to allocate, expressed in gigabytes.
    SnapshotSchedules []StorageFileSnapshotScheduleArgs
    Applies only to Endurance storage. Specifies the parameters required for a snapshot schedule.

    • snapshot_schedule.schedule_type - (Optional, String) The snapshot schedule type. Accepted values are HOURLY, WEEKLY, and DAILY.
    • snapshot_schedule.retention_count - (Optional, Integer) The retention count for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.minute - (Optional, Integer)The minute for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.hour - (Optional, Integer)The hour for a snapshot schedule. Required if schedule_type is set to DAILY or WEEKLY.
    • snapshot_schedule.day_of_week - (Optional, String) The day of the week for a snapshot schedule. Required if the schedule_type is set to WEEKLY.
    • snapshot_schedule.enable - (Optional, Bool) Whether to disable an existing snapshot schedule.
    StorageFileId string
    (String) The unique identifier of the storage volume.
    Tags []string
    Tags associated with the file storage instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    Timeouts StorageFileTimeoutsArgs
    capacity Double
    The amount of storage capacity that you want to allocate, expressed in gigabytes.
    datacenter String
    The data center where you want to provision the file storage instance.
    iops Double
    The IOPS value for the storage instance. For supported values, see provisioning considerations.
    type String
    The type of the storage. Accepted values are Endurance and Performance.
    allowedHardwareIds List<Double>
    The Bare Metal servers that you want to give access to this instance. Bare Metal servers must be in the same data center as the block storage. You can also use this field to import the list of Bare Metal servers that have access to this storage from the block_storage_ids argument in the ibm.ComputeBareMetal resource.
    allowedIpAddresses List<String>
    The IP addresses that you want to allow. IP addresses must be in the same data center as the block storage.
    allowedSubnets List<String>
    The subnets that you want to give access to this instance. Subnets must be in the same data center as the block storage.
    allowedVirtualGuestIds List<Double>
    The virtual guests that you want to give access to this instance. Virtual guests must be in the same data center as the block storage. You can also use this field to import the list of virtual guests that have access to this storage from the block_storage_ids argument in the ibm.ComputeVmInstance resource.
    hourlyBilling Boolean
    Set true to enable hourly billing. Default is false. Note Hourly billing is only available in updated data centers with improved capabilities. Refer to the file storage locations to get the updated list of data centers.
    notes String
    Descriptive text to associate with the file storage.
    snapshotCapacity Double
    The amount of snapshot capacity that you want to allocate, expressed in gigabytes.
    snapshotSchedules List<StorageFileSnapshotSchedule>
    Applies only to Endurance storage. Specifies the parameters required for a snapshot schedule.

    • snapshot_schedule.schedule_type - (Optional, String) The snapshot schedule type. Accepted values are HOURLY, WEEKLY, and DAILY.
    • snapshot_schedule.retention_count - (Optional, Integer) The retention count for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.minute - (Optional, Integer)The minute for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.hour - (Optional, Integer)The hour for a snapshot schedule. Required if schedule_type is set to DAILY or WEEKLY.
    • snapshot_schedule.day_of_week - (Optional, String) The day of the week for a snapshot schedule. Required if the schedule_type is set to WEEKLY.
    • snapshot_schedule.enable - (Optional, Bool) Whether to disable an existing snapshot schedule.
    storageFileId String
    (String) The unique identifier of the storage volume.
    tags List<String>
    Tags associated with the file storage instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    timeouts StorageFileTimeouts
    capacity number
    The amount of storage capacity that you want to allocate, expressed in gigabytes.
    datacenter string
    The data center where you want to provision the file storage instance.
    iops number
    The IOPS value for the storage instance. For supported values, see provisioning considerations.
    type string
    The type of the storage. Accepted values are Endurance and Performance.
    allowedHardwareIds number[]
    The Bare Metal servers that you want to give access to this instance. Bare Metal servers must be in the same data center as the block storage. You can also use this field to import the list of Bare Metal servers that have access to this storage from the block_storage_ids argument in the ibm.ComputeBareMetal resource.
    allowedIpAddresses string[]
    The IP addresses that you want to allow. IP addresses must be in the same data center as the block storage.
    allowedSubnets string[]
    The subnets that you want to give access to this instance. Subnets must be in the same data center as the block storage.
    allowedVirtualGuestIds number[]
    The virtual guests that you want to give access to this instance. Virtual guests must be in the same data center as the block storage. You can also use this field to import the list of virtual guests that have access to this storage from the block_storage_ids argument in the ibm.ComputeVmInstance resource.
    hourlyBilling boolean
    Set true to enable hourly billing. Default is false. Note Hourly billing is only available in updated data centers with improved capabilities. Refer to the file storage locations to get the updated list of data centers.
    notes string
    Descriptive text to associate with the file storage.
    snapshotCapacity number
    The amount of snapshot capacity that you want to allocate, expressed in gigabytes.
    snapshotSchedules StorageFileSnapshotSchedule[]
    Applies only to Endurance storage. Specifies the parameters required for a snapshot schedule.

    • snapshot_schedule.schedule_type - (Optional, String) The snapshot schedule type. Accepted values are HOURLY, WEEKLY, and DAILY.
    • snapshot_schedule.retention_count - (Optional, Integer) The retention count for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.minute - (Optional, Integer)The minute for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.hour - (Optional, Integer)The hour for a snapshot schedule. Required if schedule_type is set to DAILY or WEEKLY.
    • snapshot_schedule.day_of_week - (Optional, String) The day of the week for a snapshot schedule. Required if the schedule_type is set to WEEKLY.
    • snapshot_schedule.enable - (Optional, Bool) Whether to disable an existing snapshot schedule.
    storageFileId string
    (String) The unique identifier of the storage volume.
    tags string[]
    Tags associated with the file storage instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    timeouts StorageFileTimeouts
    capacity float
    The amount of storage capacity that you want to allocate, expressed in gigabytes.
    datacenter str
    The data center where you want to provision the file storage instance.
    iops float
    The IOPS value for the storage instance. For supported values, see provisioning considerations.
    type str
    The type of the storage. Accepted values are Endurance and Performance.
    allowed_hardware_ids Sequence[float]
    The Bare Metal servers that you want to give access to this instance. Bare Metal servers must be in the same data center as the block storage. You can also use this field to import the list of Bare Metal servers that have access to this storage from the block_storage_ids argument in the ibm.ComputeBareMetal resource.
    allowed_ip_addresses Sequence[str]
    The IP addresses that you want to allow. IP addresses must be in the same data center as the block storage.
    allowed_subnets Sequence[str]
    The subnets that you want to give access to this instance. Subnets must be in the same data center as the block storage.
    allowed_virtual_guest_ids Sequence[float]
    The virtual guests that you want to give access to this instance. Virtual guests must be in the same data center as the block storage. You can also use this field to import the list of virtual guests that have access to this storage from the block_storage_ids argument in the ibm.ComputeVmInstance resource.
    hourly_billing bool
    Set true to enable hourly billing. Default is false. Note Hourly billing is only available in updated data centers with improved capabilities. Refer to the file storage locations to get the updated list of data centers.
    notes str
    Descriptive text to associate with the file storage.
    snapshot_capacity float
    The amount of snapshot capacity that you want to allocate, expressed in gigabytes.
    snapshot_schedules Sequence[StorageFileSnapshotScheduleArgs]
    Applies only to Endurance storage. Specifies the parameters required for a snapshot schedule.

    • snapshot_schedule.schedule_type - (Optional, String) The snapshot schedule type. Accepted values are HOURLY, WEEKLY, and DAILY.
    • snapshot_schedule.retention_count - (Optional, Integer) The retention count for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.minute - (Optional, Integer)The minute for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.hour - (Optional, Integer)The hour for a snapshot schedule. Required if schedule_type is set to DAILY or WEEKLY.
    • snapshot_schedule.day_of_week - (Optional, String) The day of the week for a snapshot schedule. Required if the schedule_type is set to WEEKLY.
    • snapshot_schedule.enable - (Optional, Bool) Whether to disable an existing snapshot schedule.
    storage_file_id str
    (String) The unique identifier of the storage volume.
    tags Sequence[str]
    Tags associated with the file storage instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    timeouts StorageFileTimeoutsArgs
    capacity Number
    The amount of storage capacity that you want to allocate, expressed in gigabytes.
    datacenter String
    The data center where you want to provision the file storage instance.
    iops Number
    The IOPS value for the storage instance. For supported values, see provisioning considerations.
    type String
    The type of the storage. Accepted values are Endurance and Performance.
    allowedHardwareIds List<Number>
    The Bare Metal servers that you want to give access to this instance. Bare Metal servers must be in the same data center as the block storage. You can also use this field to import the list of Bare Metal servers that have access to this storage from the block_storage_ids argument in the ibm.ComputeBareMetal resource.
    allowedIpAddresses List<String>
    The IP addresses that you want to allow. IP addresses must be in the same data center as the block storage.
    allowedSubnets List<String>
    The subnets that you want to give access to this instance. Subnets must be in the same data center as the block storage.
    allowedVirtualGuestIds List<Number>
    The virtual guests that you want to give access to this instance. Virtual guests must be in the same data center as the block storage. You can also use this field to import the list of virtual guests that have access to this storage from the block_storage_ids argument in the ibm.ComputeVmInstance resource.
    hourlyBilling Boolean
    Set true to enable hourly billing. Default is false. Note Hourly billing is only available in updated data centers with improved capabilities. Refer to the file storage locations to get the updated list of data centers.
    notes String
    Descriptive text to associate with the file storage.
    snapshotCapacity Number
    The amount of snapshot capacity that you want to allocate, expressed in gigabytes.
    snapshotSchedules List<Property Map>
    Applies only to Endurance storage. Specifies the parameters required for a snapshot schedule.

    • snapshot_schedule.schedule_type - (Optional, String) The snapshot schedule type. Accepted values are HOURLY, WEEKLY, and DAILY.
    • snapshot_schedule.retention_count - (Optional, Integer) The retention count for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.minute - (Optional, Integer)The minute for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.hour - (Optional, Integer)The hour for a snapshot schedule. Required if schedule_type is set to DAILY or WEEKLY.
    • snapshot_schedule.day_of_week - (Optional, String) The day of the week for a snapshot schedule. Required if the schedule_type is set to WEEKLY.
    • snapshot_schedule.enable - (Optional, Bool) Whether to disable an existing snapshot schedule.
    storageFileId String
    (String) The unique identifier of the storage volume.
    tags List<String>
    Tags associated with the file storage instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StorageFile resource produces the following output properties:

    Hostname string
    (String) The fully qualified domain name of the storage.
    Id string
    The provider-assigned unique ID for this managed resource.
    Mountpoint string
    (String) The network mount address of the storage.
    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    ResourceName string
    The name of the resource
    ResourceStatus string
    The status of the resource
    Volumename string
    (String) The name of the storage volume.
    Hostname string
    (String) The fully qualified domain name of the storage.
    Id string
    The provider-assigned unique ID for this managed resource.
    Mountpoint string
    (String) The network mount address of the storage.
    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    ResourceName string
    The name of the resource
    ResourceStatus string
    The status of the resource
    Volumename string
    (String) The name of the storage volume.
    hostname String
    (String) The fully qualified domain name of the storage.
    id String
    The provider-assigned unique ID for this managed resource.
    mountpoint String
    (String) The network mount address of the storage.
    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceName String
    The name of the resource
    resourceStatus String
    The status of the resource
    volumename String
    (String) The name of the storage volume.
    hostname string
    (String) The fully qualified domain name of the storage.
    id string
    The provider-assigned unique ID for this managed resource.
    mountpoint string
    (String) The network mount address of the storage.
    resourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceName string
    The name of the resource
    resourceStatus string
    The status of the resource
    volumename string
    (String) The name of the storage volume.
    hostname str
    (String) The fully qualified domain name of the storage.
    id str
    The provider-assigned unique ID for this managed resource.
    mountpoint str
    (String) The network mount address of the storage.
    resource_controller_url str
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resource_name str
    The name of the resource
    resource_status str
    The status of the resource
    volumename str
    (String) The name of the storage volume.
    hostname String
    (String) The fully qualified domain name of the storage.
    id String
    The provider-assigned unique ID for this managed resource.
    mountpoint String
    (String) The network mount address of the storage.
    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceName String
    The name of the resource
    resourceStatus String
    The status of the resource
    volumename String
    (String) The name of the storage volume.

    Look up Existing StorageFile Resource

    Get an existing StorageFile resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: StorageFileState, opts?: CustomResourceOptions): StorageFile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allowed_hardware_ids: Optional[Sequence[float]] = None,
        allowed_ip_addresses: Optional[Sequence[str]] = None,
        allowed_subnets: Optional[Sequence[str]] = None,
        allowed_virtual_guest_ids: Optional[Sequence[float]] = None,
        capacity: Optional[float] = None,
        datacenter: Optional[str] = None,
        hostname: Optional[str] = None,
        hourly_billing: Optional[bool] = None,
        iops: Optional[float] = None,
        mountpoint: Optional[str] = None,
        notes: Optional[str] = None,
        resource_controller_url: Optional[str] = None,
        resource_name: Optional[str] = None,
        resource_status: Optional[str] = None,
        snapshot_capacity: Optional[float] = None,
        snapshot_schedules: Optional[Sequence[StorageFileSnapshotScheduleArgs]] = None,
        storage_file_id: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        timeouts: Optional[StorageFileTimeoutsArgs] = None,
        type: Optional[str] = None,
        volumename: Optional[str] = None) -> StorageFile
    func GetStorageFile(ctx *Context, name string, id IDInput, state *StorageFileState, opts ...ResourceOption) (*StorageFile, error)
    public static StorageFile Get(string name, Input<string> id, StorageFileState? state, CustomResourceOptions? opts = null)
    public static StorageFile get(String name, Output<String> id, StorageFileState state, CustomResourceOptions options)
    resources:  _:    type: ibm:StorageFile    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllowedHardwareIds List<double>
    The Bare Metal servers that you want to give access to this instance. Bare Metal servers must be in the same data center as the block storage. You can also use this field to import the list of Bare Metal servers that have access to this storage from the block_storage_ids argument in the ibm.ComputeBareMetal resource.
    AllowedIpAddresses List<string>
    The IP addresses that you want to allow. IP addresses must be in the same data center as the block storage.
    AllowedSubnets List<string>
    The subnets that you want to give access to this instance. Subnets must be in the same data center as the block storage.
    AllowedVirtualGuestIds List<double>
    The virtual guests that you want to give access to this instance. Virtual guests must be in the same data center as the block storage. You can also use this field to import the list of virtual guests that have access to this storage from the block_storage_ids argument in the ibm.ComputeVmInstance resource.
    Capacity double
    The amount of storage capacity that you want to allocate, expressed in gigabytes.
    Datacenter string
    The data center where you want to provision the file storage instance.
    Hostname string
    (String) The fully qualified domain name of the storage.
    HourlyBilling bool
    Set true to enable hourly billing. Default is false. Note Hourly billing is only available in updated data centers with improved capabilities. Refer to the file storage locations to get the updated list of data centers.
    Iops double
    The IOPS value for the storage instance. For supported values, see provisioning considerations.
    Mountpoint string
    (String) The network mount address of the storage.
    Notes string
    Descriptive text to associate with the file storage.
    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    ResourceName string
    The name of the resource
    ResourceStatus string
    The status of the resource
    SnapshotCapacity double
    The amount of snapshot capacity that you want to allocate, expressed in gigabytes.
    SnapshotSchedules List<StorageFileSnapshotSchedule>
    Applies only to Endurance storage. Specifies the parameters required for a snapshot schedule.

    • snapshot_schedule.schedule_type - (Optional, String) The snapshot schedule type. Accepted values are HOURLY, WEEKLY, and DAILY.
    • snapshot_schedule.retention_count - (Optional, Integer) The retention count for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.minute - (Optional, Integer)The minute for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.hour - (Optional, Integer)The hour for a snapshot schedule. Required if schedule_type is set to DAILY or WEEKLY.
    • snapshot_schedule.day_of_week - (Optional, String) The day of the week for a snapshot schedule. Required if the schedule_type is set to WEEKLY.
    • snapshot_schedule.enable - (Optional, Bool) Whether to disable an existing snapshot schedule.
    StorageFileId string
    (String) The unique identifier of the storage volume.
    Tags List<string>
    Tags associated with the file storage instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    Timeouts StorageFileTimeouts
    Type string
    The type of the storage. Accepted values are Endurance and Performance.
    Volumename string
    (String) The name of the storage volume.
    AllowedHardwareIds []float64
    The Bare Metal servers that you want to give access to this instance. Bare Metal servers must be in the same data center as the block storage. You can also use this field to import the list of Bare Metal servers that have access to this storage from the block_storage_ids argument in the ibm.ComputeBareMetal resource.
    AllowedIpAddresses []string
    The IP addresses that you want to allow. IP addresses must be in the same data center as the block storage.
    AllowedSubnets []string
    The subnets that you want to give access to this instance. Subnets must be in the same data center as the block storage.
    AllowedVirtualGuestIds []float64
    The virtual guests that you want to give access to this instance. Virtual guests must be in the same data center as the block storage. You can also use this field to import the list of virtual guests that have access to this storage from the block_storage_ids argument in the ibm.ComputeVmInstance resource.
    Capacity float64
    The amount of storage capacity that you want to allocate, expressed in gigabytes.
    Datacenter string
    The data center where you want to provision the file storage instance.
    Hostname string
    (String) The fully qualified domain name of the storage.
    HourlyBilling bool
    Set true to enable hourly billing. Default is false. Note Hourly billing is only available in updated data centers with improved capabilities. Refer to the file storage locations to get the updated list of data centers.
    Iops float64
    The IOPS value for the storage instance. For supported values, see provisioning considerations.
    Mountpoint string
    (String) The network mount address of the storage.
    Notes string
    Descriptive text to associate with the file storage.
    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    ResourceName string
    The name of the resource
    ResourceStatus string
    The status of the resource
    SnapshotCapacity float64
    The amount of snapshot capacity that you want to allocate, expressed in gigabytes.
    SnapshotSchedules []StorageFileSnapshotScheduleArgs
    Applies only to Endurance storage. Specifies the parameters required for a snapshot schedule.

    • snapshot_schedule.schedule_type - (Optional, String) The snapshot schedule type. Accepted values are HOURLY, WEEKLY, and DAILY.
    • snapshot_schedule.retention_count - (Optional, Integer) The retention count for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.minute - (Optional, Integer)The minute for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.hour - (Optional, Integer)The hour for a snapshot schedule. Required if schedule_type is set to DAILY or WEEKLY.
    • snapshot_schedule.day_of_week - (Optional, String) The day of the week for a snapshot schedule. Required if the schedule_type is set to WEEKLY.
    • snapshot_schedule.enable - (Optional, Bool) Whether to disable an existing snapshot schedule.
    StorageFileId string
    (String) The unique identifier of the storage volume.
    Tags []string
    Tags associated with the file storage instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    Timeouts StorageFileTimeoutsArgs
    Type string
    The type of the storage. Accepted values are Endurance and Performance.
    Volumename string
    (String) The name of the storage volume.
    allowedHardwareIds List<Double>
    The Bare Metal servers that you want to give access to this instance. Bare Metal servers must be in the same data center as the block storage. You can also use this field to import the list of Bare Metal servers that have access to this storage from the block_storage_ids argument in the ibm.ComputeBareMetal resource.
    allowedIpAddresses List<String>
    The IP addresses that you want to allow. IP addresses must be in the same data center as the block storage.
    allowedSubnets List<String>
    The subnets that you want to give access to this instance. Subnets must be in the same data center as the block storage.
    allowedVirtualGuestIds List<Double>
    The virtual guests that you want to give access to this instance. Virtual guests must be in the same data center as the block storage. You can also use this field to import the list of virtual guests that have access to this storage from the block_storage_ids argument in the ibm.ComputeVmInstance resource.
    capacity Double
    The amount of storage capacity that you want to allocate, expressed in gigabytes.
    datacenter String
    The data center where you want to provision the file storage instance.
    hostname String
    (String) The fully qualified domain name of the storage.
    hourlyBilling Boolean
    Set true to enable hourly billing. Default is false. Note Hourly billing is only available in updated data centers with improved capabilities. Refer to the file storage locations to get the updated list of data centers.
    iops Double
    The IOPS value for the storage instance. For supported values, see provisioning considerations.
    mountpoint String
    (String) The network mount address of the storage.
    notes String
    Descriptive text to associate with the file storage.
    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceName String
    The name of the resource
    resourceStatus String
    The status of the resource
    snapshotCapacity Double
    The amount of snapshot capacity that you want to allocate, expressed in gigabytes.
    snapshotSchedules List<StorageFileSnapshotSchedule>
    Applies only to Endurance storage. Specifies the parameters required for a snapshot schedule.

    • snapshot_schedule.schedule_type - (Optional, String) The snapshot schedule type. Accepted values are HOURLY, WEEKLY, and DAILY.
    • snapshot_schedule.retention_count - (Optional, Integer) The retention count for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.minute - (Optional, Integer)The minute for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.hour - (Optional, Integer)The hour for a snapshot schedule. Required if schedule_type is set to DAILY or WEEKLY.
    • snapshot_schedule.day_of_week - (Optional, String) The day of the week for a snapshot schedule. Required if the schedule_type is set to WEEKLY.
    • snapshot_schedule.enable - (Optional, Bool) Whether to disable an existing snapshot schedule.
    storageFileId String
    (String) The unique identifier of the storage volume.
    tags List<String>
    Tags associated with the file storage instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    timeouts StorageFileTimeouts
    type String
    The type of the storage. Accepted values are Endurance and Performance.
    volumename String
    (String) The name of the storage volume.
    allowedHardwareIds number[]
    The Bare Metal servers that you want to give access to this instance. Bare Metal servers must be in the same data center as the block storage. You can also use this field to import the list of Bare Metal servers that have access to this storage from the block_storage_ids argument in the ibm.ComputeBareMetal resource.
    allowedIpAddresses string[]
    The IP addresses that you want to allow. IP addresses must be in the same data center as the block storage.
    allowedSubnets string[]
    The subnets that you want to give access to this instance. Subnets must be in the same data center as the block storage.
    allowedVirtualGuestIds number[]
    The virtual guests that you want to give access to this instance. Virtual guests must be in the same data center as the block storage. You can also use this field to import the list of virtual guests that have access to this storage from the block_storage_ids argument in the ibm.ComputeVmInstance resource.
    capacity number
    The amount of storage capacity that you want to allocate, expressed in gigabytes.
    datacenter string
    The data center where you want to provision the file storage instance.
    hostname string
    (String) The fully qualified domain name of the storage.
    hourlyBilling boolean
    Set true to enable hourly billing. Default is false. Note Hourly billing is only available in updated data centers with improved capabilities. Refer to the file storage locations to get the updated list of data centers.
    iops number
    The IOPS value for the storage instance. For supported values, see provisioning considerations.
    mountpoint string
    (String) The network mount address of the storage.
    notes string
    Descriptive text to associate with the file storage.
    resourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceName string
    The name of the resource
    resourceStatus string
    The status of the resource
    snapshotCapacity number
    The amount of snapshot capacity that you want to allocate, expressed in gigabytes.
    snapshotSchedules StorageFileSnapshotSchedule[]
    Applies only to Endurance storage. Specifies the parameters required for a snapshot schedule.

    • snapshot_schedule.schedule_type - (Optional, String) The snapshot schedule type. Accepted values are HOURLY, WEEKLY, and DAILY.
    • snapshot_schedule.retention_count - (Optional, Integer) The retention count for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.minute - (Optional, Integer)The minute for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.hour - (Optional, Integer)The hour for a snapshot schedule. Required if schedule_type is set to DAILY or WEEKLY.
    • snapshot_schedule.day_of_week - (Optional, String) The day of the week for a snapshot schedule. Required if the schedule_type is set to WEEKLY.
    • snapshot_schedule.enable - (Optional, Bool) Whether to disable an existing snapshot schedule.
    storageFileId string
    (String) The unique identifier of the storage volume.
    tags string[]
    Tags associated with the file storage instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    timeouts StorageFileTimeouts
    type string
    The type of the storage. Accepted values are Endurance and Performance.
    volumename string
    (String) The name of the storage volume.
    allowed_hardware_ids Sequence[float]
    The Bare Metal servers that you want to give access to this instance. Bare Metal servers must be in the same data center as the block storage. You can also use this field to import the list of Bare Metal servers that have access to this storage from the block_storage_ids argument in the ibm.ComputeBareMetal resource.
    allowed_ip_addresses Sequence[str]
    The IP addresses that you want to allow. IP addresses must be in the same data center as the block storage.
    allowed_subnets Sequence[str]
    The subnets that you want to give access to this instance. Subnets must be in the same data center as the block storage.
    allowed_virtual_guest_ids Sequence[float]
    The virtual guests that you want to give access to this instance. Virtual guests must be in the same data center as the block storage. You can also use this field to import the list of virtual guests that have access to this storage from the block_storage_ids argument in the ibm.ComputeVmInstance resource.
    capacity float
    The amount of storage capacity that you want to allocate, expressed in gigabytes.
    datacenter str
    The data center where you want to provision the file storage instance.
    hostname str
    (String) The fully qualified domain name of the storage.
    hourly_billing bool
    Set true to enable hourly billing. Default is false. Note Hourly billing is only available in updated data centers with improved capabilities. Refer to the file storage locations to get the updated list of data centers.
    iops float
    The IOPS value for the storage instance. For supported values, see provisioning considerations.
    mountpoint str
    (String) The network mount address of the storage.
    notes str
    Descriptive text to associate with the file storage.
    resource_controller_url str
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resource_name str
    The name of the resource
    resource_status str
    The status of the resource
    snapshot_capacity float
    The amount of snapshot capacity that you want to allocate, expressed in gigabytes.
    snapshot_schedules Sequence[StorageFileSnapshotScheduleArgs]
    Applies only to Endurance storage. Specifies the parameters required for a snapshot schedule.

    • snapshot_schedule.schedule_type - (Optional, String) The snapshot schedule type. Accepted values are HOURLY, WEEKLY, and DAILY.
    • snapshot_schedule.retention_count - (Optional, Integer) The retention count for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.minute - (Optional, Integer)The minute for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.hour - (Optional, Integer)The hour for a snapshot schedule. Required if schedule_type is set to DAILY or WEEKLY.
    • snapshot_schedule.day_of_week - (Optional, String) The day of the week for a snapshot schedule. Required if the schedule_type is set to WEEKLY.
    • snapshot_schedule.enable - (Optional, Bool) Whether to disable an existing snapshot schedule.
    storage_file_id str
    (String) The unique identifier of the storage volume.
    tags Sequence[str]
    Tags associated with the file storage instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    timeouts StorageFileTimeoutsArgs
    type str
    The type of the storage. Accepted values are Endurance and Performance.
    volumename str
    (String) The name of the storage volume.
    allowedHardwareIds List<Number>
    The Bare Metal servers that you want to give access to this instance. Bare Metal servers must be in the same data center as the block storage. You can also use this field to import the list of Bare Metal servers that have access to this storage from the block_storage_ids argument in the ibm.ComputeBareMetal resource.
    allowedIpAddresses List<String>
    The IP addresses that you want to allow. IP addresses must be in the same data center as the block storage.
    allowedSubnets List<String>
    The subnets that you want to give access to this instance. Subnets must be in the same data center as the block storage.
    allowedVirtualGuestIds List<Number>
    The virtual guests that you want to give access to this instance. Virtual guests must be in the same data center as the block storage. You can also use this field to import the list of virtual guests that have access to this storage from the block_storage_ids argument in the ibm.ComputeVmInstance resource.
    capacity Number
    The amount of storage capacity that you want to allocate, expressed in gigabytes.
    datacenter String
    The data center where you want to provision the file storage instance.
    hostname String
    (String) The fully qualified domain name of the storage.
    hourlyBilling Boolean
    Set true to enable hourly billing. Default is false. Note Hourly billing is only available in updated data centers with improved capabilities. Refer to the file storage locations to get the updated list of data centers.
    iops Number
    The IOPS value for the storage instance. For supported values, see provisioning considerations.
    mountpoint String
    (String) The network mount address of the storage.
    notes String
    Descriptive text to associate with the file storage.
    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceName String
    The name of the resource
    resourceStatus String
    The status of the resource
    snapshotCapacity Number
    The amount of snapshot capacity that you want to allocate, expressed in gigabytes.
    snapshotSchedules List<Property Map>
    Applies only to Endurance storage. Specifies the parameters required for a snapshot schedule.

    • snapshot_schedule.schedule_type - (Optional, String) The snapshot schedule type. Accepted values are HOURLY, WEEKLY, and DAILY.
    • snapshot_schedule.retention_count - (Optional, Integer) The retention count for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.minute - (Optional, Integer)The minute for a snapshot schedule. Required for all types of schedule_type.
    • snapshot_schedule.hour - (Optional, Integer)The hour for a snapshot schedule. Required if schedule_type is set to DAILY or WEEKLY.
    • snapshot_schedule.day_of_week - (Optional, String) The day of the week for a snapshot schedule. Required if the schedule_type is set to WEEKLY.
    • snapshot_schedule.enable - (Optional, Bool) Whether to disable an existing snapshot schedule.
    storageFileId String
    (String) The unique identifier of the storage volume.
    tags List<String>
    Tags associated with the file storage instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    timeouts Property Map
    type String
    The type of the storage. Accepted values are Endurance and Performance.
    volumename String
    (String) The name of the storage volume.

    Supporting Types

    StorageFileSnapshotSchedule, StorageFileSnapshotScheduleArgs

    RetentionCount double
    Retention count
    ScheduleType string
    schedule type
    DayOfWeek string
    Day of the week
    Enable bool
    Hour double
    Time duration in hour
    Minute double
    Time duration in minutes
    RetentionCount float64
    Retention count
    ScheduleType string
    schedule type
    DayOfWeek string
    Day of the week
    Enable bool
    Hour float64
    Time duration in hour
    Minute float64
    Time duration in minutes
    retentionCount Double
    Retention count
    scheduleType String
    schedule type
    dayOfWeek String
    Day of the week
    enable Boolean
    hour Double
    Time duration in hour
    minute Double
    Time duration in minutes
    retentionCount number
    Retention count
    scheduleType string
    schedule type
    dayOfWeek string
    Day of the week
    enable boolean
    hour number
    Time duration in hour
    minute number
    Time duration in minutes
    retention_count float
    Retention count
    schedule_type str
    schedule type
    day_of_week str
    Day of the week
    enable bool
    hour float
    Time duration in hour
    minute float
    Time duration in minutes
    retentionCount Number
    Retention count
    scheduleType String
    schedule type
    dayOfWeek String
    Day of the week
    enable Boolean
    hour Number
    Time duration in hour
    minute Number
    Time duration in minutes

    StorageFileTimeouts, StorageFileTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm