IF Commons GitHub

mirror status

verbread

Say whether a replica is in sync with its primary, behind it, or has diverged.

Program anyfs-writer. Origin anyfs.

Governance: the action

What the verb is and may do, as governance says it. Each annotation is expressed by the surfaces or says why it is not.

PropertyValue
kindreport
effectread
idempotenttrue
audienceboth
tierreader
dryRunfalse
checkfalse
reachChannelslocal, ssh, mcp, rest
reachReadOnlytrue
reachNeedsTtyfalse
reachRunsAscaller
reachConfirmationnone

Operands

OperandMeaning
PRIMARYThe directory that is the source of truth.
REPLICAThe directory that follows it.

Options

OptionMeaningProperties
--includeOnly paths that match a glob (a * is within one name, ** crosses directories); give it again for more.type=many, required=false, standard=false, humanOnly=false, valueName=GLOB
--excludeLeave out paths that match a glob; give it again for more.type=many, required=false, standard=false, humanOnly=false, valueName=GLOB
--jsonWrite one JSON document and nothing else for a person.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false
--sarifWrite the findings as SARIF 2.1.0 and nothing else.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false
--quietShow only how it ended.type=flag, short=q, required=false, standard=true, humanOnly=false, negatable=false, default=false
--verboseShow every step as it happens.type=flag, short=v, required=false, standard=true, humanOnly=false, negatable=false, default=false
--colorUse colour where the terminal shows it (--no-color turns it off).type=flag, required=false, standard=true, humanOnly=false, negatable=true, default=true
--non-interactiveNever ask a question: where one is needed, fail and say so.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false
--onRun it on these targets instead of here: ids joined by commas, `class:<class>` or `all`.type=value, required=false, standard=true, humanOnly=false, valueName=VALUE

Examples

anyfs mirror status fleet:/ s3backup:/fleet  # Whether the replica is in sync with the primary, behind it, or has diverged.

Physical: what it is drawn as

anyfs mirror status

cli-command. Say whether a replica is in sync with its primary, behind it, or has diverged.

PropertyValue
usageanyfs mirror status
wordsmirror, status
tierreader

anyfs_mirror_status

mcp-tool. Say whether a replica is in sync with its primary, behind it, or has diverged. (report, effect read, safe to repeat.)

PropertyValue
titleanyfs mirror status
toolNameanyfs_mirror_status
readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
inputsinclude, exclude, PRIMARY, REPLICA
requiredPRIMARY, REPLICA
tierreader

GET /v1/mirror/status

rest-route. Say whether a replica is in sync with its primary, behind it, or has diverged.

PropertyValue
methodGET
path/v1/mirror/status
operationIdanyfs_mirror_status
effectread
tierreader
idempotenttrue

Titles, headings, exports, tables, columns and requirements. Esc closes.