steampipe plugin install oci

Table: oci_file_storage_file_system - Query OCI File Storage Systems using SQL

Oracle Cloud Infrastructure (OCI) File Storage service provides a durable, scalable, secure, enterprise-grade network file system. You can connect to a File Storage service file system from any bare metal, virtual machine, or container instance in your Virtual Cloud Network (VCN). The File Storage service supports the Network File System (NFS) protocol.

Table Usage Guide

The oci_file_storage_file_system table provides insights into file systems within Oracle Cloud Infrastructure (OCI) File Storage. As a cloud engineer, explore file system-specific details through this table, including size, mount targets, and associated metadata. Utilize it to uncover information about file systems, such as their capacity, the associated VCN, and the security of the file system.

Examples

Basic info

  1. "Explore the basic information about your file systems, such as their display name, ID, lifecycle state, availability domain, metered bytes, and creation time."
  2. "Identify instances where file systems are not in an active state, which might indicate potential issues or unused resources."
  3. "Discover the file systems that have been cloned, providing a quick overview of your duplicated resources."
  4. "Review the file systems that use Oracle managed encryption, to ensure data security and compliance with your organization's encryption policies.
select
display_name,
id,
lifecycle_state as state,
availability_domain,
metered_bytes,
time_created
from
oci_file_storage_file_system;
select
display_name,
id,
lifecycle_state as state,
availability_domain,
metered_bytes,
time_created
from
oci_file_storage_file_system;

List file systems that are not active

select
display_name,
id,
lifecycle_state as state
from
oci_file_storage_file_system
where
lifecycle_state <> 'ACTIVE';
select
display_name,
id,
lifecycle_state as state
from
oci_file_storage_file_system
where
lifecycle_state <> 'ACTIVE';

List cloned file systems

select
display_name,
id,
lifecycle_state as state
from
oci_file_storage_file_system
where
is_clone_parent;
select
display_name,
id,
lifecycle_state as state
from
oci_file_storage_file_system
where
is_clone_parent = 1;

List file systems with Oracle managed encryption (default encryption uses Oracle managed encryption keys)

select
display_name,
id,
lifecycle_state as state,
time_created
from
oci_file_storage_file_system
where
length(kms_key_id) = 0;
select
display_name,
id,
lifecycle_state as state,
time_created
from
oci_file_storage_file_system
where
length(kms_key_id) = 0;

List file systems with customer managed encryption keys

Explore file systems that utilize customer-managed encryption keys to enhance data security and privacy. This allows for a better understanding of your system's security measures and helps identify potential areas for improvement.

select
display_name,
id,
lifecycle_state as state,
kms_key_id,
time_created
from
oci_file_storage_file_system
where
length(kms_key_id) <> 0;
select
display_name,
id,
lifecycle_state as state,
kms_key_id,
time_created
from
oci_file_storage_file_system
where
length(kms_key_id) <> 0;

Schema for oci_file_storage_file_system

NameTypeOperatorsDescription
_ctxjsonbSteampipe context in JSON form.
availability_domaintext=The availability domain the file system is in.
compartment_idtext=The OCID of the compartment in Tenant in which the resource is located.
defined_tagsjsonbDefined tags for resource. Defined tags are set up in your tenancy by an administrator. Only users granted permission to work with the defined tags can apply them to resources.
display_nametext=A user-friendly name. It does not have to be unique, and it is changeable.
exportsjsonbA list of export resources by file system.
freeform_tagsjsonbFree-form tags for resource. This tags can be applied by any user with permissions on the resource.
idtext=The OCID of the file system.
is_clone_parentbooleanSpecifies whether the file system has been cloned.
is_hydratedbooleanSpecifies whether the data has finished copying from the source to the clone.
kms_key_idtextThe OCID of the KMS key used to encrypt the encryption keys associated with this file system.
lifecycle_detailstextAdditional information about the current 'lifecycleState'.
lifecycle_statetext=The current state of the file system.
metered_bytesbigintThe number of bytes consumed by the file system.
regiontextThe OCI region in which the resource is located.
source_detailsjsonbSource information for the file system.
sp_connection_nametext=, !=, ~~, ~~*, !~~, !~~*Steampipe connection name.
sp_ctxjsonbSteampipe context in JSON form.
tagsjsonbA map of tags for the resource.
tenant_idtext=, !=, ~~, ~~*, !~~, !~~*The OCID of the Tenant in which the resource is located.
tenant_nametextThe name of the Tenant in which the resource is located.
time_createdtimestamp with time zoneThe date and time the file system was created.
titletextTitle of the resource.

Export

This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- oci

You can pass the configuration to the command with the --config argument:

steampipe_export_oci --config '<your_config>' oci_file_storage_file_system