Reference

CLI reference

Every dm command, flag, and exit code used by Easy Hybrid DR.

Product: Easy Hybrid DR
Version: v2.3.1
Release status: GA
Documentation status: Published
Last updated: Updated May 25, 2026
Reading time: 1 min read

The dm command-line tool is the supported interface for scripting and operations. Every console action has a CLI equivalent. This page lists commands by topic.

Global flags

Parameter	Type	Required	Description
--workspace	string	optional	Target workspace. Defaults to the value of $DM_WORKSPACE.
--output	enum	optional	Output format: table, json, or yaml. Default: table
--quiet	boolean	optional	Suppress non-error output. Useful in CI.
--profile	string	optional	Named credentials profile from the CLI keyring.

Authentication

POSTdm auth login

bash

dm auth login --token $DM_TOKEN
dm auth logout
dm auth whoami

Sources

bash

dm sources list [--tag KEY=VALUE]
dm sources describe --name <source>
dm sources tag --name <source> --tag <key>=<value>
dm sources untag --name <source> --tag <key>=<value>

Plans

bash

dm plan apply -f protection-plan.yaml
dm plan list
dm plan describe <name>
dm plan run --name <plan>
dm plan pause --name <plan>
dm plan resume --name <plan>
dm plan delete --name <plan>

Failover and failback

bash

dm plan quiesce --name <plan>
dm plan failover --name <plan> --recovery-point <id|latest> [--skip-source-quiesce]
dm plan failback --name <plan>
dm plan validate --name <plan>

Jobs and monitoring

bash

dm jobs list [--plan <plan>] [--since 24h]
dm jobs watch --plan <plan>
dm jobs cancel --id <job>

Recovery points

bash

dm recovery-points list --plan <plan> [--limit 20]
dm recovery-points describe --id <id>
dm recovery-points prune --plan <plan> --keep 30

Exit codes

Code	Meaning
0	Success
2	Invalid argument or flag combination
3	Authentication failed
4	Resource not found
5	Conflict (resource exists, plan running, etc.)
10	Job failed at the target
11	Job failed at the source
20	Unexpected server error

Related docs

Was this page helpful?