Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.FileStorage.getFileSystems

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

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

const testFileSystems = oci.FileStorage.getFileSystems({
    availabilityDomain: fileSystemAvailabilityDomain,
    compartmentId: compartmentId,
    displayName: fileSystemDisplayName,
    filesystemSnapshotPolicyId: testFilesystemSnapshotPolicy.id,
    id: fileSystemId,
    parentFileSystemId: testFileSystem.id,
    sourceSnapshotId: testSnapshot.id,
    state: fileSystemState,
});

import pulumi
import pulumi_oci as oci

test_file_systems = oci.FileStorage.get_file_systems(availability_domain=file_system_availability_domain,
    compartment_id=compartment_id,
    display_name=file_system_display_name,
    filesystem_snapshot_policy_id=test_filesystem_snapshot_policy["id"],
    id=file_system_id,
    parent_file_system_id=test_file_system["id"],
    source_snapshot_id=test_snapshot["id"],
    state=file_system_state)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/filestorage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := filestorage.GetFileSystems(ctx, &filestorage.GetFileSystemsArgs{
			AvailabilityDomain:         fileSystemAvailabilityDomain,
			CompartmentId:              compartmentId,
			DisplayName:                pulumi.StringRef(fileSystemDisplayName),
			FilesystemSnapshotPolicyId: pulumi.StringRef(testFilesystemSnapshotPolicy.Id),
			Id:                         pulumi.StringRef(fileSystemId),
			ParentFileSystemId:         pulumi.StringRef(testFileSystem.Id),
			SourceSnapshotId:           pulumi.StringRef(testSnapshot.Id),
			State:                      pulumi.StringRef(fileSystemState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testFileSystems = Oci.FileStorage.GetFileSystems.Invoke(new()
    {
        AvailabilityDomain = fileSystemAvailabilityDomain,
        CompartmentId = compartmentId,
        DisplayName = fileSystemDisplayName,
        FilesystemSnapshotPolicyId = testFilesystemSnapshotPolicy.Id,
        Id = fileSystemId,
        ParentFileSystemId = testFileSystem.Id,
        SourceSnapshotId = testSnapshot.Id,
        State = fileSystemState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.FileStorage.FileStorageFunctions;
import com.pulumi.oci.FileStorage.inputs.GetFileSystemsArgs;
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) {
        final var testFileSystems = FileStorageFunctions.getFileSystems(GetFileSystemsArgs.builder()
            .availabilityDomain(fileSystemAvailabilityDomain)
            .compartmentId(compartmentId)
            .displayName(fileSystemDisplayName)
            .filesystemSnapshotPolicyId(testFilesystemSnapshotPolicy.id())
            .id(fileSystemId)
            .parentFileSystemId(testFileSystem.id())
            .sourceSnapshotId(testSnapshot.id())
            .state(fileSystemState)
            .build());

    }
}

variables:
  testFileSystems:
    fn::invoke:
      function: oci:FileStorage:getFileSystems
      arguments:
        availabilityDomain: ${fileSystemAvailabilityDomain}
        compartmentId: ${compartmentId}
        displayName: ${fileSystemDisplayName}
        filesystemSnapshotPolicyId: ${testFilesystemSnapshotPolicy.id}
        id: ${fileSystemId}
        parentFileSystemId: ${testFileSystem.id}
        sourceSnapshotId: ${testSnapshot.id}
        state: ${fileSystemState}

Using getFileSystems

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFileSystems(args: GetFileSystemsArgs, opts?: InvokeOptions): Promise<GetFileSystemsResult>
function getFileSystemsOutput(args: GetFileSystemsOutputArgs, opts?: InvokeOptions): Output<GetFileSystemsResult>

def get_file_systems(availability_domain: Optional[str] = None,
                     compartment_id: Optional[str] = None,
                     display_name: Optional[str] = None,
                     filesystem_snapshot_policy_id: Optional[str] = None,
                     filters: Optional[Sequence[_filestorage.GetFileSystemsFilter]] = None,
                     id: Optional[str] = None,
                     parent_file_system_id: Optional[str] = None,
                     source_snapshot_id: Optional[str] = None,
                     state: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetFileSystemsResult
def get_file_systems_output(availability_domain: Optional[pulumi.Input[str]] = None,
                     compartment_id: Optional[pulumi.Input[str]] = None,
                     display_name: Optional[pulumi.Input[str]] = None,
                     filesystem_snapshot_policy_id: Optional[pulumi.Input[str]] = None,
                     filters: Optional[pulumi.Input[Sequence[pulumi.Input[_filestorage.GetFileSystemsFilterArgs]]]] = None,
                     id: Optional[pulumi.Input[str]] = None,
                     parent_file_system_id: Optional[pulumi.Input[str]] = None,
                     source_snapshot_id: Optional[pulumi.Input[str]] = None,
                     state: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetFileSystemsResult]

func GetFileSystems(ctx *Context, args *GetFileSystemsArgs, opts ...InvokeOption) (*GetFileSystemsResult, error)
func GetFileSystemsOutput(ctx *Context, args *GetFileSystemsOutputArgs, opts ...InvokeOption) GetFileSystemsResultOutput

> Note: This function is named GetFileSystems in the Go SDK.

public static class GetFileSystems 
{
    public static Task<GetFileSystemsResult> InvokeAsync(GetFileSystemsArgs args, InvokeOptions? opts = null)
    public static Output<GetFileSystemsResult> Invoke(GetFileSystemsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetFileSystemsResult> getFileSystems(GetFileSystemsArgs args, InvokeOptions options)
public static Output<GetFileSystemsResult> getFileSystems(GetFileSystemsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:FileStorage/getFileSystems:getFileSystems
  arguments:
    # arguments dictionary

The following arguments are supported:

AvailabilityDomain string: The name of the availability domain. Example: Uocm:PHX-AD-1
CompartmentId string: The OCID of the compartment.
DisplayName string: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
FilesystemSnapshotPolicyId string: The OCID of the file system snapshot policy that is associated with the file systems.
Filters List<GetFileSystemsFilter>
Id string: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
ParentFileSystemId string: The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
SourceSnapshotId string: The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

AvailabilityDomain string: The name of the availability domain. Example: Uocm:PHX-AD-1
CompartmentId string: The OCID of the compartment.
DisplayName string: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
FilesystemSnapshotPolicyId string: The OCID of the file system snapshot policy that is associated with the file systems.
Filters []GetFileSystemsFilter
Id string: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
ParentFileSystemId string: The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
SourceSnapshotId string: The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

availabilityDomain String: The name of the availability domain. Example: Uocm:PHX-AD-1
compartmentId String: The OCID of the compartment.
displayName String: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
filesystemSnapshotPolicyId String: The OCID of the file system snapshot policy that is associated with the file systems.
filters List<GetFileSystemsFilter>
id String: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
parentFileSystemId String: The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
sourceSnapshotId String: The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

availabilityDomain string: The name of the availability domain. Example: Uocm:PHX-AD-1
compartmentId string: The OCID of the compartment.
displayName string: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
filesystemSnapshotPolicyId string: The OCID of the file system snapshot policy that is associated with the file systems.
filters GetFileSystemsFilter[]
id string: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
parentFileSystemId string: The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
sourceSnapshotId string: The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
state string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

availability_domain str: The name of the availability domain. Example: Uocm:PHX-AD-1
compartment_id str: The OCID of the compartment.
display_name str: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
filesystem_snapshot_policy_id str: The OCID of the file system snapshot policy that is associated with the file systems.
filters Sequence[filestorage.GetFileSystemsFilter]
id str: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
parent_file_system_id str: The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
source_snapshot_id str: The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
state str: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

availabilityDomain String: The name of the availability domain. Example: Uocm:PHX-AD-1
compartmentId String: The OCID of the compartment.
displayName String: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
filesystemSnapshotPolicyId String: The OCID of the file system snapshot policy that is associated with the file systems.
filters List<Property Map>
id String: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
parentFileSystemId String: The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
sourceSnapshotId String: The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

getFileSystems Result

The following output properties are available:

AvailabilityDomain string: The availability domain the file system is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
CompartmentId string: The OCID of the compartment that contains the file system.
FileSystems List<GetFileSystemsFileSystem>: The list of file_systems.
DisplayName string: A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My file system
FilesystemSnapshotPolicyId string: The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.
Filters List<GetFileSystemsFilter>
Id string: The OCID of the file system.
ParentFileSystemId string: The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
SourceSnapshotId string: The OCID of the source snapshot used to create a cloned file system. See Cloning a File System.
State string: The current state of the file system.

AvailabilityDomain string: The availability domain the file system is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
CompartmentId string: The OCID of the compartment that contains the file system.
FileSystems []GetFileSystemsFileSystem: The list of file_systems.
DisplayName string: A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My file system
FilesystemSnapshotPolicyId string: The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.
Filters []GetFileSystemsFilter
Id string: The OCID of the file system.
ParentFileSystemId string: The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
SourceSnapshotId string: The OCID of the source snapshot used to create a cloned file system. See Cloning a File System.
State string: The current state of the file system.

availabilityDomain String: The availability domain the file system is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
compartmentId String: The OCID of the compartment that contains the file system.
fileSystems List<GetFileSystemsFileSystem>: The list of file_systems.
displayName String: A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My file system
filesystemSnapshotPolicyId String: The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.
filters List<GetFileSystemsFilter>
id String: The OCID of the file system.
parentFileSystemId String: The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
sourceSnapshotId String: The OCID of the source snapshot used to create a cloned file system. See Cloning a File System.
state String: The current state of the file system.

availabilityDomain string: The availability domain the file system is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
compartmentId string: The OCID of the compartment that contains the file system.
fileSystems GetFileSystemsFileSystem[]: The list of file_systems.
displayName string: A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My file system
filesystemSnapshotPolicyId string: The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.
filters GetFileSystemsFilter[]
id string: The OCID of the file system.
parentFileSystemId string: The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
sourceSnapshotId string: The OCID of the source snapshot used to create a cloned file system. See Cloning a File System.
state string: The current state of the file system.

availability_domain str: The availability domain the file system is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
compartment_id str: The OCID of the compartment that contains the file system.
file_systems Sequence[filestorage.GetFileSystemsFileSystem]: The list of file_systems.
display_name str: A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My file system
filesystem_snapshot_policy_id str: The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.
filters Sequence[filestorage.GetFileSystemsFilter]
id str: The OCID of the file system.
parent_file_system_id str: The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
source_snapshot_id str: The OCID of the source snapshot used to create a cloned file system. See Cloning a File System.
state str: The current state of the file system.

availabilityDomain String: The availability domain the file system is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
compartmentId String: The OCID of the compartment that contains the file system.
fileSystems List<Property Map>: The list of file_systems.
displayName String: A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My file system
filesystemSnapshotPolicyId String: The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.
filters List<Property Map>
id String: The OCID of the file system.
parentFileSystemId String: The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
sourceSnapshotId String: The OCID of the source snapshot used to create a cloned file system. See Cloning a File System.
state String: The current state of the file system.

Supporting Types

GetFileSystemsFileSystem

AreQuotaRulesEnabled bool: Specifies the enforcement of quota rules on the file system.
AvailabilityDomain string: The name of the availability domain. Example: Uocm:PHX-AD-1
CloneAttachStatus string: Specifies whether the file system is attached to its parent file system.
CloneCount int: Specifies the total number of children of a file system.
CompartmentId string: The OCID of the compartment.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DetachCloneTrigger int
DisplayName string: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
FilesystemSnapshotPolicyId string: The OCID of the file system snapshot policy that is associated with the file systems.
FreeformTags Dictionary<string, string>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
IsCloneParent bool: Specifies whether the file system has been cloned. See Cloning a File System.
IsHydrated bool: Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.
IsLockOverride bool
IsTargetable bool: Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false. For more information, see Using Replication.
KmsKeyId string: The OCID of the KMS key used to encrypt the encryption keys associated with this file system.
LifecycleDetails string: Additional information about the current 'lifecycleState'.
Locks List<GetFileSystemsFileSystemLock>: Locks associated with this resource.
MeteredBytes string: The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.
QuotaEnforcementState string: Displays the state of enforcement of quota rules on the file system.
ReplicationSourceCount int: Specifies the total number of replications for which this file system is a source.
ReplicationTargetId string: The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
SourceDetails List<GetFileSystemsFileSystemSourceDetail>: Source information for the file system.
SourceSnapshotId string: The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
SystemTags Dictionary<string, string>: System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
TimeCreated string: The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

AreQuotaRulesEnabled bool: Specifies the enforcement of quota rules on the file system.
AvailabilityDomain string: The name of the availability domain. Example: Uocm:PHX-AD-1
CloneAttachStatus string: Specifies whether the file system is attached to its parent file system.
CloneCount int: Specifies the total number of children of a file system.
CompartmentId string: The OCID of the compartment.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DetachCloneTrigger int
DisplayName string: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
FilesystemSnapshotPolicyId string: The OCID of the file system snapshot policy that is associated with the file systems.
FreeformTags map[string]string: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
IsCloneParent bool: Specifies whether the file system has been cloned. See Cloning a File System.
IsHydrated bool: Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.
IsLockOverride bool
IsTargetable bool: Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false. For more information, see Using Replication.
KmsKeyId string: The OCID of the KMS key used to encrypt the encryption keys associated with this file system.
LifecycleDetails string: Additional information about the current 'lifecycleState'.
Locks []GetFileSystemsFileSystemLock: Locks associated with this resource.
MeteredBytes string: The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.
QuotaEnforcementState string: Displays the state of enforcement of quota rules on the file system.
ReplicationSourceCount int: Specifies the total number of replications for which this file system is a source.
ReplicationTargetId string: The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
SourceDetails []GetFileSystemsFileSystemSourceDetail: Source information for the file system.
SourceSnapshotId string: The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
SystemTags map[string]string: System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
TimeCreated string: The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

areQuotaRulesEnabled Boolean: Specifies the enforcement of quota rules on the file system.
availabilityDomain String: The name of the availability domain. Example: Uocm:PHX-AD-1
cloneAttachStatus String: Specifies whether the file system is attached to its parent file system.
cloneCount Integer: Specifies the total number of children of a file system.
compartmentId String: The OCID of the compartment.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
detachCloneTrigger Integer
displayName String: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
filesystemSnapshotPolicyId String: The OCID of the file system snapshot policy that is associated with the file systems.
freeformTags Map<String,String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
isCloneParent Boolean: Specifies whether the file system has been cloned. See Cloning a File System.
isHydrated Boolean: Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.
isLockOverride Boolean
isTargetable Boolean: Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false. For more information, see Using Replication.
kmsKeyId String: The OCID of the KMS key used to encrypt the encryption keys associated with this file system.
lifecycleDetails String: Additional information about the current 'lifecycleState'.
locks List<GetFileSystemsFileSystemLock>: Locks associated with this resource.
meteredBytes String: The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.
quotaEnforcementState String: Displays the state of enforcement of quota rules on the file system.
replicationSourceCount Integer: Specifies the total number of replications for which this file system is a source.
replicationTargetId String: The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
sourceDetails List<GetFileSystemsFileSystemSourceDetail>: Source information for the file system.
sourceSnapshotId String: The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
systemTags Map<String,String>: System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated String: The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

areQuotaRulesEnabled boolean: Specifies the enforcement of quota rules on the file system.
availabilityDomain string: The name of the availability domain. Example: Uocm:PHX-AD-1
cloneAttachStatus string: Specifies whether the file system is attached to its parent file system.
cloneCount number: Specifies the total number of children of a file system.
compartmentId string: The OCID of the compartment.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
detachCloneTrigger number
displayName string: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
filesystemSnapshotPolicyId string: The OCID of the file system snapshot policy that is associated with the file systems.
freeformTags {[key: string]: string}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id string: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
isCloneParent boolean: Specifies whether the file system has been cloned. See Cloning a File System.
isHydrated boolean: Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.
isLockOverride boolean
isTargetable boolean: Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false. For more information, see Using Replication.
kmsKeyId string: The OCID of the KMS key used to encrypt the encryption keys associated with this file system.
lifecycleDetails string: Additional information about the current 'lifecycleState'.
locks GetFileSystemsFileSystemLock[]: Locks associated with this resource.
meteredBytes string: The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.
quotaEnforcementState string: Displays the state of enforcement of quota rules on the file system.
replicationSourceCount number: Specifies the total number of replications for which this file system is a source.
replicationTargetId string: The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
sourceDetails GetFileSystemsFileSystemSourceDetail[]: Source information for the file system.
sourceSnapshotId string: The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
state string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
systemTags {[key: string]: string}: System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated string: The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

are_quota_rules_enabled bool: Specifies the enforcement of quota rules on the file system.
availability_domain str: The name of the availability domain. Example: Uocm:PHX-AD-1
clone_attach_status str: Specifies whether the file system is attached to its parent file system.
clone_count int: Specifies the total number of children of a file system.
compartment_id str: The OCID of the compartment.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
detach_clone_trigger int
display_name str: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
filesystem_snapshot_policy_id str: The OCID of the file system snapshot policy that is associated with the file systems.
freeform_tags Mapping[str, str]: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id str: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
is_clone_parent bool: Specifies whether the file system has been cloned. See Cloning a File System.
is_hydrated bool: Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.
is_lock_override bool
is_targetable bool: Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false. For more information, see Using Replication.
kms_key_id str: The OCID of the KMS key used to encrypt the encryption keys associated with this file system.
lifecycle_details str: Additional information about the current 'lifecycleState'.
locks Sequence[filestorage.GetFileSystemsFileSystemLock]: Locks associated with this resource.
metered_bytes str: The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.
quota_enforcement_state str: Displays the state of enforcement of quota rules on the file system.
replication_source_count int: Specifies the total number of replications for which this file system is a source.
replication_target_id str: The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
source_details Sequence[filestorage.GetFileSystemsFileSystemSourceDetail]: Source information for the file system.
source_snapshot_id str: The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
state str: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
system_tags Mapping[str, str]: System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
time_created str: The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

areQuotaRulesEnabled Boolean: Specifies the enforcement of quota rules on the file system.
availabilityDomain String: The name of the availability domain. Example: Uocm:PHX-AD-1
cloneAttachStatus String: Specifies whether the file system is attached to its parent file system.
cloneCount Number: Specifies the total number of children of a file system.
compartmentId String: The OCID of the compartment.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
detachCloneTrigger Number
displayName String: A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
filesystemSnapshotPolicyId String: The OCID of the file system snapshot policy that is associated with the file systems.
freeformTags Map<String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: Filter results by OCID. Must be an OCID of the correct type for the resouce type.
isCloneParent Boolean: Specifies whether the file system has been cloned. See Cloning a File System.
isHydrated Boolean: Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.
isLockOverride Boolean
isTargetable Boolean: Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false. For more information, see Using Replication.
kmsKeyId String: The OCID of the KMS key used to encrypt the encryption keys associated with this file system.
lifecycleDetails String: Additional information about the current 'lifecycleState'.
locks List<Property Map>: Locks associated with this resource.
meteredBytes String: The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.
quotaEnforcementState String: Displays the state of enforcement of quota rules on the file system.
replicationSourceCount Number: Specifies the total number of replications for which this file system is a source.
replicationTargetId String: The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
sourceDetails List<Property Map>: Source information for the file system.
sourceSnapshotId String: The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
systemTags Map<String>: System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated String: The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

GetFileSystemsFileSystemLock

Message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
RelatedResourceId string: The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated string: The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
Type string: Type of the lock.

Message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
RelatedResourceId string: The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated string: The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
Type string: Type of the lock.

message String: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId String: The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated String: The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
type String: Type of the lock.

message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId string: The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated string: The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
type string: Type of the lock.

message str: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
related_resource_id str: The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
time_created str: The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
type str: Type of the lock.

message String: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId String: The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated String: The date and time the file system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
type String: Type of the lock.

GetFileSystemsFileSystemSourceDetail

ParentFileSystemId string: The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
SourceSnapshotId string: The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

ParentFileSystemId string: The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
SourceSnapshotId string: The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

parentFileSystemId String: The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
sourceSnapshotId String: The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

parentFileSystemId string: The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
sourceSnapshotId string: The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

parent_file_system_id str: The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
source_snapshot_id str: The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

parentFileSystemId String: The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
sourceSnapshotId String: The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

GetFileSystemsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.FileStorage.getFileSystems

On this page

On this page

Example Usage

Using getFileSystems

getFileSystems Result

Supporting Types

GetFileSystemsFileSystem

GetFileSystemsFileSystemLock

GetFileSystemsFileSystemSourceDetail

GetFileSystemsFilter

Package Details

On this page

On this page