Command map

request data backup

Write a backup of the whole store to a file on the daemon's host.

Ze command

Registry path
request data backup
Usage
request data backup <path> [spare <spare>] [force]
Mode
Daemon
Wire method
ze-data:backup
Backends
any backend
Task support
optional: the MCP call is synchronous, which is the default
Subcommands
none: this command takes no subcommand
Pipes, always
json, ndjson, table, text, yaml, raw, no-more, save
Pipes, when the answer has rows
match, count, first, last, display, fill
Pipes, while streaming
log
Pipes, local process only
save

Description

Copies every key of the store into one blob artifact while the daemon runs. A
commit that lands meanwhile is in the backup whole or not at all. The file holds
credentials and private keys and is written 0600.

Arguments

NameTypeRequiredValuesSummaryDescription
pathstringyesany value of this typeAbsolute artifact pathAbsolute path of the artifact. A relative path, a '..' element, a symlink, and every name the store owns in its folder are refused, each naming the rule it broke.
spareuintnoany value of this typeSpare capacity percent (0-100)Spare capacity in percent that each key and data slot carries. An artifact is normally copied whole, so the default is 0.
forceflagnoany value of this typeReplace an existing fileReplace an existing file at path. It never lifts a refusal of a name the store owns.

Mapping status

No vendor equivalent has been curated yet for this Ze command.

Juniper Junos MX

No equivalent is listed for this vendor yet.

Cisco IOS XR

No equivalent is listed for this vendor yet.

Nokia SR OS

No equivalent is listed for this vendor yet.

VyOS

No equivalent is listed for this vendor yet.