Skip to content

Commit

Permalink
Sync bitbucket and GitHub
Browse files Browse the repository at this point in the history
  • Loading branch information
carchi8py committed Jul 6, 2023
1 parent f099c54 commit 9e8d225
Show file tree
Hide file tree
Showing 2 changed files with 82 additions and 1 deletion.
80 changes: 80 additions & 0 deletions docs/resources/storage_snapshot_policy_resource.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
page_title: "netapp-ontap_storage_snapshot_policy_resource Resource - terraform-provider-netapp-ontap"
subcategory: "storage"
description: |-
SnapshotPolicy resource
---

# Resource storage_snapshot_policy_resource

Create/Modify/Delete a SnapshotPolicy resource

## Example Usage

```terraform
# Create a storage snapshot policy
resource "netapp-ontap_storage_snapshot_policy_resource" "storage_snapshot_policy" {
# required to know which system to interface with
cx_profile_name = "cluster4"
name = "testsnapshotpolicy"
svm_name = "ansibleSVM"
comment = "Test for terraform snapshot policy resource"
enabled = false
copies = [
{
count = 2
schedule = {
name = "weekly"
}
},
{
count = 4
schedule = {
name = "hourly"
}
},
]
}
```

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

### Required

- `copies` (Attributes List) Snapshot copy (see [below for nested schema](#nestedatt--copies))
- `cx_profile_name` (String) Connection profile name
- `name` (String) SnapshotPolicy name

### Optional

- `comment` (String) A comment associated with the Snapshot copy policy
- `enabled` (Boolean) Is the Snapshot copy policy enabled?
- `svm_name` (String) SnapshotPolicy vserver name

### Read-Only

- `uuid` (String) SnapshotPolicy UUID

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

Required:

- `count` (Number) The number of Snapshot copies to maintain for this schedule
- `schedule` (Attributes) Schedule at which Snapshot copies are captured on the volume (see [below for nested schema](#nestedatt--copies--schedule))

Optional:

- `prefix` (String) The prefix to use while creating Snapshot copies at regular intervals
- `retention_period` (String) The retention period of Snapshot copies for this schedule
- `snapmirror_label` (String) Label for SnapMirror operations

<a id="nestedatt--copies--schedule"></a>
### Nested Schema for `copies.schedule`

Required:

- `name` (String) Some common schedules already defined in the system are hourly, daily, weekly, at 15 minute intervals, and at 5 minute intervals. Snapshot copy policies with custom schedules can be referenced


3 changes: 2 additions & 1 deletion scripts/generate_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
'snaplock': [],
'snapmirror': [],
'storage': [
"storage_snapshot_policy_resource.md",
"storage_volume_snapshot_data_source.md",
"storage_volume_resource.md",
"storage_volume_data_source.md",
Expand All @@ -47,7 +48,7 @@

def main():
print("===== Generating docs =====")
# generate_doc()
generate_doc()
remove_example()
print("===== Adding Catagories =====")
add_catagories()
Expand Down

0 comments on commit 9e8d225

Please sign in to comment.