diff --git a/README.md b/README.md index 531b2d7..5f0541f 100644 --- a/README.md +++ b/README.md @@ -13,19 +13,20 @@ chmod +x /root/proxmox-autosnap/proxmox-autosnap.py ## Help -| Arguments | Required | Type | Default | Description | -|----------------|----------|------|---------|------------------------------------------------------------------| -| vmid | yes | list | empty | Space separated list of CT/VM ID or `all` for all CT/VM in node. | -| snap | yes | bool | false | Create a snapshot but do not delete anything. | -| autosnap | no | bool | false | Create a snapshot and delete the old one. | -| keep | no | int | 30 | The number of snapshots which should will keep. | -| label | no | str | daily | One of `hourly`, `daily`, `weekly`, `monthly`. | -| clean | no | bool | false | Delete all or selected autosnapshots. | -| exclude | no | list | empty | Space separated list of CT/VM ID to exclude from processing. | -| mute | no | bool | false | Output only errors. | -| running | no | bool | false | Run only on running vm, skip on stopped. | -| includevmstate | no | bool | false | Include the VM state in snapshots. | -| dryrun | no | bool | false | Do not create or delete snapshots, just print the commands. | +| Arguments | Required | Type | Default | Description | +|-----------------|----------|------|---------|------------------------------------------------------------------| +| vmid | yes | list | empty | Space separated list of CT/VM ID or `all` for all CT/VM in node. | +| snap | yes | bool | false | Create a snapshot but do not delete anything. | +| autosnap | no | bool | false | Create a snapshot and delete the old one. | +| keep | no | int | 30 | The number of snapshots which should will keep. | +| label | no | str | daily | One of `hourly`, `daily`, `weekly`, `monthly`. | +| clean | no | bool | false | Delete all or selected autosnapshots. | +| exclude | no | list | empty | Space separated list of CT/VM ID to exclude from processing. | +| mute | no | bool | false | Output only errors. | +| running | no | bool | false | Run only on running vm, skip on stopped. | +| includevmstate | no | bool | false | Include the VM state in snapshots. | +| dryrun | no | bool | false | Do not create or delete snapshots, just print the commands. | +| date-iso-format | no | bool | false | Store snapshots in ISO 8601 format. | > proxmox-autosnap.py --help @@ -52,6 +53,11 @@ proxmox-autosnap.py --snap --vmid all --label hourly # Delete all hourly autosnapshots for all VM proxmox-autosnap.py --clean --vmid all --label hourly --keep 0 + +# Create snapshots in ISO 8601 format +# Example autodaily_2023_03_22T01_26_23 +# It is not necessary to specify the --date-iso-format argument to delete snapshots +proxmox-autosnap.py --snap --vmid 100 --date-iso-format ``` ## Cron