create_snapshot_policy
Automate dataset snapshots on TrueNAS Core by defining a policy with schedule, retention settings, and recursive options for child datasets.
Instructions
Create an automated snapshot policy
Args:
dataset: Dataset to snapshot
name: Policy name
schedule: Schedule configuration (cron-like)
{"minute": "0", "hour": "*/4", "dom": "*", "month": "*", "dow": "*"}
retention: Retention settings {"hourly": 24, "daily": 7, "weekly": 4, "monthly": 12}
recursive: Include child datasets
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dataset | Yes | ||
| name | Yes | ||
| recursive | No | ||
| retention | Yes | ||
| schedule | Yes |
Input Schema (JSON Schema)
{
"properties": {
"dataset": {
"title": "Dataset",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"recursive": {
"default": true,
"title": "Recursive",
"type": "boolean"
},
"retention": {
"additionalProperties": {
"type": "integer"
},
"title": "Retention",
"type": "object"
},
"schedule": {
"title": "Schedule",
"type": "object"
}
},
"required": [
"dataset",
"name",
"schedule",
"retention"
],
"title": "create_snapshot_policyArguments",
"type": "object"
}