Articles in this section

See more

protectionpolicy modify

Sara Levy
  • Updated
Follow

This command modifies a protection policy.

Usage

protectionpolicy modify --id ID
                       [--name POLICY_NAME]
                       [--schedule SCHEDULE] 
                       [--prefix PREFIX]
                       [--clone-type CLOUD_REPLICATION|LOCAL]
                       [--target-object-id ID]

Required Parameters

--id ID

Specifies the protection policy to modify.

Options

--schedule SCHEDULE

Modifies the schedule for snapshots. If --clone-type is set to CLOUD_REPLICATION, the schedule applies also to replication to S3.

The schedule includes a frequency in seconds, minutes, hours or days, a start date and time, and a retention time limit for local snapshots.

Specify SCHEDULE in the following format:

every <number><time units> start at YYYY-MM-DD HH:MM:SS keep-local <number><time units>

<time units> can be any of the following:

  • s - seconds

  • m - minutes

  • h - hours

  • d - days

keep-local sets the amount of time to retain each local snapshot on the cluster. S3 backups do not expire and do not have a retention period.

If --clone-type is set to CLOUD_REPLICATION, then the minimum supported frequency is 6 hours, which can be written as 6h.

For example: --schedule every 90m start at 2025-07-27 20:10:35 keep-local 10h

--prefix PREFIX

Modifies the prefix to use in the names of snapshots.

--clone-type CLOUD_REPLICATION|LOCAL

Changes the type(s) of replication to perform:

  • CLOUD_REPLICATION. Take local snapshots and also replicate to an S3 replication peer.

  • LOCAL. Take snapshots on the local cluster only.

--name POLICY_NAME

Modifies the name of the protection policy.

--target-object-id ID

If --clone-type is set to CLOUD_REPLICATION, include this option to add or modify the S3 replication peer.

Specify ID as an integer.

To retrieve target IDs, use replicationtarget list.

To create a target, use replicationtarget create.

Example

This example changes the snapshot prefix of replication policy 1 to "vast".

vcli: admin> protectionpolicy modify --id 1 --prefix vast

Related articles

Comments

0 comments

Article is closed for comments.