Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added filesystem snapshot datasource #127

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 14 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 150 additions & 0 deletions docs/data-sources/filesystem.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
---
# Copyright (c) 2025 Dell Inc., or its subsidiaries. All Rights Reserved.
#
# Licensed under the Mozilla Public License Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://mozilla.org/MPL/2.0/
#
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

title: "powerstore_filesystem data source"
linkTitle: "powerstore_filesystem"
page_title: "powerstore_filesystem Data Source - powerstore"
subcategory: ""
description: |-
This datasource is used to query the existing File System from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.
---

# powerstore_filesystem (Data Source)

This datasource is used to query the existing File System from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.

> **Note:** Only one of `name` or `id` or `nas_server_id` can be provided at a time.

## Example Usage

```terraform
/*
Copyright (c) 2025 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://mozilla.org/MPL/2.0/


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# commands to run this tf file : terraform init && terraform apply --auto-approve
# This datasource reads filesystems either by id or name where user can provide a value to any one of them
# If it is a empty datsource block , then it will read all the filesystems
# If id or name is provided then it reads a particular filesystem with that id or name
# Only one of the attribute can be provided among id and name

#Fetching filesystem using name
data "powerstore_filesystem" "test1" {
name = "ephemeral-csi-0e62d1cdec3b543a0740e9a307df221187955b47af4b99b7be31ebd9cb6192ce"
}

#Fetching filesystem using id
data "powerstore_filesystem" "test2" {
id = "6568282e-c982-62ce-5ac3-52518d324736"
}

#Fetching filesystem using nas server id
data "powerstore_filesystem" "test3" {
nas_server_id = "654b2182-f674-f39a-66fc-52518d324736"
}

# Fetching all filesystems
data "powerstore_filesystem" "test4" {
}


output "result" {
value = data.powerstore_filesystem.test3.filesystems
}
```
After the successful execution of above said block, We can see the output by executing `terraform output` command. Also, we can fetch information via the variable: `data.powerstore_filesystem_snapshot.test1` where name is the attribute which user wants to fetch.

<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- `id` (String) Unique identifier of the File System. Conflicts with `name` and `nas_server_id`.
- `name` (String) File System name. Conflicts with `id` and `nas_server_id`.
- `nas_server_id` (String) Nas server ID. Conflicts with `id` and `name`.

### Read-Only

- `filesystems` (Attributes List) List of File System. (see [below for nested schema](#nestedatt--filesystems))

<a id="nestedatt--filesystems"></a>
### Nested Schema for `filesystems`

Read-Only:

- `access_policy` (String) Access Policy of the File System
- `access_type` (String) Access Type of the File System
- `config_type` (String) Config Type of the File System
- `creation_timestamp` (String) Creation Timestamp of the File System
- `creator_type` (String) Creator Type of the File System
- `default_hard_limit` (Number) Default Hard Limit of the File System
- `default_soft_limit` (Number) Default Soft Limit of the File System
- `description` (String) Description of the File System
- `expiration_timestamp` (String) Expiration Timestamp of the File System
- `file_events_publishing_mode` (String) State of the event notification services for all file systems
- `filesystem_type` (String) Filesystem Type of the File System
- `flr_attributes` (Attributes) Flr Attributes of the File System (see [below for nested schema](#nestedatt--filesystems--flr_attributes))
- `folder_rename_policy` (String) Folder Rename Policy of the File System
- `grace_period` (Number) Grace Period of the File System
- `host_io_size` (String) Typical size of writes
- `id` (String) ID of the File System
- `is_async_m_time_enabled` (Boolean) Is Async MTime Enabled of the File System
- `is_modified` (Boolean) Is Modified of the File System
- `is_quota_enabled` (Boolean) Is Quota Enabled of the File System
- `is_smb_no_notify_enabled` (Boolean) Is Smb No Notify Enabled of the File System
- `is_smb_notify_on_access_enabled` (Boolean) Is Smb Notify On Access Enabled of the File System
- `is_smb_notify_on_write_enabled` (Boolean) Is Smb Notify On Write Enabled of the File System
- `is_smb_op_locks_enabled` (Boolean) Is Smb Op Locks Enabled of the File System
- `is_smb_sync_writes_enabled` (Boolean) Is Smb Sync Writes Enabled of the File System
- `last_refresh_timestamp` (String) Last Refresh Timestamp of the File System
- `last_writable_timestamp` (String) Last Writable Timestamp of the File System
- `locking_policy` (String) Locking Policy of the File System
- `name` (String) Name of the File System
- `nas_server_id` (String) Nas Server ID of the File System
- `parent_id` (String) Parent ID of the File System
- `protection_policy_id` (String) Protection Policy ID of the File System
- `size_total` (Number) Size Total of the File System
- `size_used` (Number) Size Used of the File System
- `smb_notify_on_change_dir_depth` (Number) Smb Notify On Change Dir Depth of the File System

<a id="nestedatt--filesystems--flr_attributes"></a>
### Nested Schema for `filesystems.flr_attributes`

Read-Only:

- `auto_delete` (Boolean) Auto Delete of the File System
- `auto_lock` (Boolean) Auto Lock of the File System
- `clock_time` (String) Clock Time of the File System
- `default_retention` (String) Default Retention of the File System
- `has_protected_files` (Boolean) Has Protected Files of the File System
- `maximum_retention` (String) Maximum Retention of the File System
- `maximum_retention_date` (String) Maximum Retention Date of the File System
- `minimum_retention` (String) Minimum Retention of the File System
- `mode` (String) Mode of the File System
- `policy_interval` (Number) Policy Interval of the File System
175 changes: 175 additions & 0 deletions docs/data-sources/filesystem_snapshot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
---
# Copyright (c) 2025 Dell Inc., or its subsidiaries. All Rights Reserved.
#
# Licensed under the Mozilla Public License Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://mozilla.org/MPL/2.0/
#
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

title: "powerstore_filesystem_snapshot data source"
linkTitle: "powerstore_filesystem_snapshot"
page_title: "powerstore_filesystem_snapshot Data Source - powerstore"
subcategory: ""
description: |-
This datasource is used to query the existing File System Snapshot from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.
---

# powerstore_filesystem_snapshot (Data Source)

This datasource is used to query the existing File System Snapshot from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.

> **Note:** Only one of `name` or `id` or `filesystem_id` can be provided at a time.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This description seems outdated. Same in file_system daatasource.


## Example Usage

```terraform
/*
Copyright (c) 2025 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://mozilla.org/MPL/2.0/


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# commands to run this tf file : terraform init && terraform apply --auto-approve
# This datasource reads hosts either by id or name where user can provide a value to any one of them
# If it is a empty datsource block , then it will read all the filesystem
# If id or name is provided then it reads a particular file system snapshot with that id or name
# If filesystem_id is provided then it will read all the filesystem snapshots within filesystem
# Only one of the attribute can be provided among id or name or filesystem_id


// create filesystem
resource "powerstore_filesystem" "test" {
name = "test_fs"
description = "testing file system"
size = 3
nas_server_id = "<nas_server_id>"
flr_attributes = {
mode = "Enterprise"
minimum_retention = "1D"
default_retention = "1D"
maximum_retention = "infinite"
}
config_type = "General"
access_policy = "UNIX"
locking_policy = "Advisory"
folder_rename_policy = "All_Allowed"
is_smb_sync_writes_enabled = true
is_smb_no_notify_enabled = true
is_smb_op_locks_enabled = false
is_smb_notify_on_access_enabled = true
is_smb_notify_on_write_enabled = false
smb_notify_on_change_dir_depth = 12
is_async_mtime_enabled = true
file_events_publishing_mode = "All"
}

// create snapshot from filesystem
resource "powerstore_filesystem_snapshot" "test" {
name = "tf_fs_snap"
description = "Test File System Snapshot Resource"
filesystem_id = resource.powerstore_filesystem.test.id
expiration_timestamp = "2035-05-06T09:01:47Z"
access_type = "Snapshot"
}

data "powerstore_filesystem_snapshot" "test1" {
name = resource.powerstore_filesystem_snapshot.test.name
Copy link
Contributor

@rounak-adhikary rounak-adhikary Jan 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Datasource examples are not given with resource prereqs since users will probably never write any code like this. Datasource examples can have datasource prereqs (eg. filesystem datasource prereq for filesystem_snapshot daatsource).
Only resource examples use resource or datasource prereqs, covering probable common scenarios.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, better give an example with nas_server_id

# id = resource.powerstore_filesystem_snapshot.test.id
# filesystem_id= resource.powerstore_filesystem.test.id
}


output "fileSystemSnapshotResult" {
value = data.powerstore_filesystem_snapshot.test1.filesystem_snapshots
}
```
After the successful execution of above said block, We can see the output by executing `terraform output` command. Also, we can fetch information via the variable: `data.powerstore_filesystem_snapshot.test1` where name is the attribute which user wants to fetch.

<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- `filesystem_id` (String) File System ID of the Snapshot. Conflicts with `id` and `nas_server_id`.
- `id` (String) Unique identifier of the File System Snapshot. Conflicts with `name` and `filesystem_id`.
- `name` (String) File System Snapshot name. Conflicts with `id`.
- `nas_server_id` (String) Nas Server ID of the Snapshot. Conflicts with `id` and `filesystem_id`.

### Read-Only

- `filesystem_snapshots` (Attributes List) List of File System Snapshots. (see [below for nested schema](#nestedatt--filesystem_snapshots))

<a id="nestedatt--filesystem_snapshots"></a>
### Nested Schema for `filesystem_snapshots`

Read-Only:

- `access_policy` (String) Access Policy of the File System
- `access_type` (String) Access Type of the File System
- `config_type` (String) Config Type of the File System
- `creation_timestamp` (String) Creation Timestamp of the File System
- `creator_type` (String) Creator Type of the File System
- `default_hard_limit` (Number) Default Hard Limit of the File System
- `default_soft_limit` (Number) Default Soft Limit of the File System
- `description` (String) Description of the File System
- `expiration_timestamp` (String) Expiration Timestamp of the File System
- `file_events_publishing_mode` (String) State of the event notification services for all file systems
- `filesystem_type` (String) Filesystem Type of the File System
- `flr_attributes` (Attributes) Flr Attributes of the File System (see [below for nested schema](#nestedatt--filesystem_snapshots--flr_attributes))
- `folder_rename_policy` (String) Folder Rename Policy of the File System
- `grace_period` (Number) Grace Period of the File System
- `host_io_size` (String) Typical size of writes
- `id` (String) ID of the File System
- `is_async_m_time_enabled` (Boolean) Is Async MTime Enabled of the File System
- `is_modified` (Boolean) Is Modified of the File System
- `is_quota_enabled` (Boolean) Is Quota Enabled of the File System
- `is_smb_no_notify_enabled` (Boolean) Is Smb No Notify Enabled of the File System
- `is_smb_notify_on_access_enabled` (Boolean) Is Smb Notify On Access Enabled of the File System
- `is_smb_notify_on_write_enabled` (Boolean) Is Smb Notify On Write Enabled of the File System
- `is_smb_op_locks_enabled` (Boolean) Is Smb Op Locks Enabled of the File System
- `is_smb_sync_writes_enabled` (Boolean) Is Smb Sync Writes Enabled of the File System
- `last_refresh_timestamp` (String) Last Refresh Timestamp of the File System
- `last_writable_timestamp` (String) Last Writable Timestamp of the File System
- `locking_policy` (String) Locking Policy of the File System
- `name` (String) Name of the File System
- `nas_server_id` (String) Nas Server ID of the File System
- `parent_id` (String) Parent ID of the File System
- `protection_policy_id` (String) Protection Policy ID of the File System
- `size_total` (Number) Size Total of the File System
- `size_used` (Number) Size Used of the File System
- `smb_notify_on_change_dir_depth` (Number) Smb Notify On Change Dir Depth of the File System

<a id="nestedatt--filesystem_snapshots--flr_attributes"></a>
### Nested Schema for `filesystem_snapshots.flr_attributes`

Read-Only:

- `auto_delete` (Boolean) Auto Delete of the File System
- `auto_lock` (Boolean) Auto Lock of the File System
- `clock_time` (String) Clock Time of the File System
- `default_retention` (String) Default Retention of the File System
- `has_protected_files` (Boolean) Has Protected Files of the File System
- `maximum_retention` (String) Maximum Retention of the File System
- `maximum_retention_date` (String) Maximum Retention Date of the File System
- `minimum_retention` (String) Minimum Retention of the File System
- `mode` (String) Mode of the File System
- `policy_interval` (Number) Policy Interval of the File System
10 changes: 5 additions & 5 deletions docs/resources/filesystem_snapshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,11 @@ limitations under the License.
# To check which attributes of the file system snapshot resource can be updated, please refer Product Guide in the documentation

resource "powerstore_filesystem_snapshot" "test1" {
name = "tf_fs_snap"
description = "Test File System Snapshot Resource"
filesystem_id="67608dc7-b69c-b762-0522-42848bc63a0b"
expiration_timestamp="2035-05-06T09:01:47Z"
access_type = "Snapshot"
name = "tf_fs_snap"
description = "Test File System Snapshot Resource"
filesystem_id = "67608dc7-b69c-b762-0522-42848bc63a0b"
expiration_timestamp = "2035-05-06T09:01:47Z"
access_type = "Snapshot"
}
```

Expand Down
46 changes: 46 additions & 0 deletions examples/data-sources/powerstore_filesystem/data-source.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/*
Copyright (c) 2025 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://mozilla.org/MPL/2.0/


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# commands to run this tf file : terraform init && terraform apply --auto-approve
# This datasource reads filesystems either by id or name where user can provide a value to any one of them
# If it is a empty datsource block , then it will read all the filesystems
# If id or name is provided then it reads a particular filesystem with that id or name
# Only one of the attribute can be provided among id and name

#Fetching filesystem using name
data "powerstore_filesystem" "test1" {
name = "ephemeral-csi-0e62d1cdec3b543a0740e9a307df221187955b47af4b99b7be31ebd9cb6192ce"
}

#Fetching filesystem using id
data "powerstore_filesystem" "test2" {
id = "6568282e-c982-62ce-5ac3-52518d324736"
}

#Fetching filesystem using nas server id
data "powerstore_filesystem" "test3" {
nas_server_id = "654b2182-f674-f39a-66fc-52518d324736"
}

# Fetching all filesystems
data "powerstore_filesystem" "test4" {
}


output "result" {
value = data.powerstore_filesystem.test3.filesystems
}
Loading
Loading