Skip to Content
Browse documentation

transferctl — Command Reference

Start, inspect or stop a scheduled migration job by UUID.

Start, inspect or stop a scheduled migration job by UUID.

Requirements

Run as root on the Eenos server. An already scheduled valid migration job, protected job storage and root access. Replace the example UUID with the intended job ID; this CLI does not discover a source or schedule a new job.

Usage

The following example uses the operation described below; replace example identities and paths before use:

/usr/local/eenos/scripts/transferctl status 00000000-0000-4000-8000-000000000000 --json

Arguments and options

Argument / optionUsage and meaning
actionPositional argument. Choices: start, status, stop, _run. Migration job command
idPositional argument. Scheduled migration job UUID
--jsonFlag. Show structured JSON output for scripts

-h, --help displays this parser's help. The installed version remains authoritative for available options.

Operational effects

start launches a pending job in the background; status inspects it; stop requests cancellation without undoing restored data. A terminal job is not restarted through start.

Normal actions are start, status and stop. The parser also accepts internal _run, --root, --lock-fd and --ready-fd; these are reserved for controller startup and testing and should not be supplied during ordinary administration.

See Transfer Progress and migration verification. Use --json for structured status; this does not make the underlying operation read-only when action is start or stop.

Verify the result

Inspect account results, errors and logs. The internal _run action and hidden descriptor/storage switches are implementation interfaces, not normal operator commands.

Check operation output and the relevant service/application state. Several legacy wrappers exit successfully after logging a handler failure, so a zero shell exit status alone is not proof of completion.

Back to Administration & Internal Tools · All command-line tools