Documentation Index

Fetch the complete documentation index at: https://kb.vastdata.com/llms.txt

Use this file to discover all available pages before exploring further.

protectedpath add-stream

Prev Next

This command adds a destination to a replication protected path or to a global access protected path.

Usage - Async Replication

protectedpath add-stream --id ID
                         --name NAME
                         --capabilities ASYNC_REPLICATION
                        [--protection-policy-id ID]
                        [--target-exported-dir]
                        [--remote-tenant-name TENANT_NAME]
                        [--enable-bucket-replication|--disable-bucket-replication]

Usage - Global Access

protectedpath add-stream --id ID
                         --name NAME
                         --capabilities GLOBAL_ACCESS
                        [--target-exported-dir PATH]
                        [--remote-tenant-name TENANT_NAME]
                        [--remote-target-id PEER_ID]

Required Parameters

--id ID

Specifies the protected path by its ID.

--name NAME

A name for the destination.

--capabilities ASYNC_REPLICATION|GLOBAL_ACCESS

Specifies if the destination is for replication (ASYNC_REPLICATION) or for global access (GLOBAL_ACCESS).

Replication Options

--protection-policy-id ID

The ID of the protection policy that specifies the destination peer and other parameters for replicating to the destination, such as the replication schedule.

--target-exported-dir PATH

Specifies the path on the destination peer to which the protected path should replicate data.

--remote-tenant-name TENANT_NAME

Specifies the name of the remote tenant on which you want to create the target directory.

By default, the target directory is created on the default tenant.

--enable-bucket-replication

Enables bucket replication for the replication stream.

Bucket replication cannot be enabled or disabled after the stream is created.

--disable-bucket-replication

Disables bucket replication for the replication stream.

Bucket replication cannot be enabled or disabled after the stream is created.

Global Access Options

--target-exported-dir PATH

Specifies the path on the destination peer to be shared for global access. This must be a directory that does not yet exist on the remote peer.

--remote-tenant-name TENANT_NAME

Specifies the name of the remote tenant on which you want to create the directory specified by --target-exported-dir.

By default, the directory is created on the default tenant.

--remote-target-id PEER_ID

Specifies a destination peer for the global access path.

Specify PEER_ID as an integer ID of a replicationpeer object (to list replication peers, run replicationpeer list.

Example

vcli: admin> protectedpath add-stream --id 6 --name vcli-stream-b-c --protection-policy-id 7