protectedpath modify

This command can be used to:

Deactivate a protected path. This pauses snapshots and replication according to the protection policy associated with the protected path. Managing Protected PathsManaging Protection Policies
Activate a protected path if it was previously deactivated. This resumes snapshots and replication according to the protection policy associated with the protected path.
Initiate a failover in an async replication scenario. This must be done from the destination peer's VMS.
Abort a graceful failover during the first phase of the failover when the protected data is read-only on both peers.
Change the name of a protected path.

In async replication, where the protected path is mirrored on the destination peer, activation/deactivation can be done from either peer. Failover is initiated from the destination peer.

Usage

protectedpath modify  --id ID
                     [--name NAME]
                     [--activate]
                     [--deactivate]
                     [--modify-replication-state]
                     [--abort-modify-replication-state]
                     [--graceful]
                     [--ungraceful]
                     [--sync-interval SYNC_INTERVAL]
                     [--capabilities ASYNC_REPLICATION | STARED_GLOBAL_NAMESPACE | REPLICATION_AND_GN | SYNC_REPLICATION]
                     [--sync-disconnect-time TIME]

Note
The --lease-expiry-time option is not supported.

Required Parameters

--id ID

Specify the protected path by its ID.

Options

`--name NAME`	Changes the name of the protected path.
`--activate`	Activates a protected path if previously deactivated.
`--deactivate`	Deactivates a protected path.
`--modify-replication-state`	Initiates an asynchronous replication failover or synchronous turnover. Must be run from the destination peer and used with either `--graceful` or `--ungraceful` to specify the type of failover/turnover.
`--abort-modify-replication-state`	Aborts a failover. Must be run from the destination peer. The abort operation is supported for graceful failovers during the read-only phase.
`--graceful`	Specifies failover type as graceful. Use in addition to `--modify-replication-state` to initiate failover/turnover.
`--ungraceful`	Specifies failover type as ungraceful. Use in addition to `--modify-replication-state` to initiate failover/turnover.
`--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)
`--capabilities ASYNC_REPLICATION \| STARED_GLOBAL_NAMESPACE \| REPLICATION_AND_GN \| SYNC_REPLICATION`	The mode or purpose of the protected path: ASYNC_REPLICATION. The path is used for Asynchronous Replication STARED_GLOBAL_NAMESPACE. The path is used for Global Access REPLICATION_AND_GN. The path is used for Global Access and Asynchronous Replication. This configures the path for Global Access, but also captures snapshots as with Asynchronous Replication, that can be used if the Global Access connection drops on the replication group. SYNC_REPLICATION. The path is used for Synchronous Replication. If SYNC_REPLICATION is specified, `--sync-disconnect-time` must also be specified.
`--sync-disconnect-time TIME`	The period of time, in seconds, after which a primary and secondary cluster, configured for synchronous replication, will revert to standalone clusters (and no longer replicate data) if communication between them is lost. Default value: 45 seconds

Example

This example suspends a protected path whose ID is 1.

vcli: admin> protectedpath modify --id 1 --deactivate

This example starts a graceful failover on protected path with ID 3.

vcli: admin> protectedpath modify --id 3 --modify-replication-state --graceful