protectedpath create

Prev Next

This command creates a protected path.

Usage

protectedpath create --name NAME
                     --protection-policy-id PROTECTION_POLICY_ID
                     --source-dir SOURCE_DIR
                      --local-tenant-id ID
                     [--target-exported-dir PATH_ON_PEER]
                     [--remote-tenant-name NAME]
                     [--sync-interval SYNC_INTERVAL]

Required Parameters

--name NAME

Sets a name for the protected path.

--protection-policy-id ID

Specifies which protection policy to apply to the protected path.

Warning

After creating the protected path, it is not possible to change which policy is associated with the protected path. All changes to a protected path's snapshot schedule, replication schedule, and snapshot expiration must be done by modifying the protection policy. Those modifications affect all protected paths that use the same protection policy. To work around this limitation, create a protection policy per protected path.

--source-dir SOURCE-DIR

Specifies the path to a directory to back up. A snapshot of this directory will be taken periodically on the schedule configured in the protection policy.

For example: --source-dir /

--local-tenant-id ID

Specifies to which local tenant the path belongs.

Options

--target-exported-dir PATH_ON_PEER

For async replication, specify the path on the destination peer where the data should be replicated. This must be a directory that does not yet exist on the async replication peer.

Tip

You cannot use "/" as path on peer because that always exists already. Therefore if you would like to replicate all data under the root directory, you will need to replicate this to a subdirectory. e.g. path on peer = "mirror/"

--remote-tenant-name NAME

If --target-exported-dir is specified, this option specifies which tenant on the destination peer --target-exported-dir belongs to.

--sync-interval SYNC_INTERVAL

The maximum duration gap between restore points of members in the replication group, in seconds. Guarantees that a common restore point exists between group members within the specified duration.

Default value: 86400 seconds (1 day)

Example

vcli: admin> protectedpath create --name stream1 --protection-policy-id 1 --source-dir /