Skip to main content

MigrationChecklistItem

idMigrationChecklistItemIdrequired

Possible values: [appdata_cache, initial_sync, full_scrub, notifications, schedules, user_scripts, restore_drill]

statusstringrequired

Possible values: [todo, done, not_applicable]

acknowledgeablebooleanrequired

True only for user_scripts and restore_drill while they are not acknowledged. An item with a record is never acknowledgeable.

doneAtstring<date-time>

When the record says it was done, or when it was acknowledged.

jobIdstring

The job the item derives from. For restore_drill, the latest succeeded fix job that had a path (startFix), which an acknowledgement records. A fix of the whole array or of one disk is not a restore drill and is not shown.

acknowledgedBystring

Who acknowledged it, local for the daemon's own socket.

acknowledgedAtstring<date-time>
notifications object
channelsinteger<int32>required

How many notification channels exist.

testedinteger<int32>required

How many are enabled and have a test that succeeded since they last changed.

agentsstring[]required

The names of the Unraid notification agents the scan found, never anything inside them: recreate each as a channel.

schedules object
moverbooleanrequired

Whether the nightly chain's mover step is enabled.

syncbooleanrequired

Whether the nightly chain's sync step is enabled. Unraid has no sync schedule to carry over, so the user chooses one.

scrubbooleanrequired

Whether the nightly chain's scrub step is enabled.

chainStartTimestringrequired

Local time the chain starts, HH:MM.

weeklyScrubDayWeekdayrequired

Day of week, 0=Sunday through 6=Saturday.

Possible values: >= 0 and <= 6

offers objectrequired

Values read from Unraid's configuration that the schedules item offers to carry over. A value the flash did not have is absent, never an "off".

moverCronstring

Unraid's mover schedule, as written.

moverTimestring

HH:MM when the mover schedule is a daily line, offered as the nightly chain's start time.

parityCheck object

Unraid's parity-check schedule as dynamix.cfg wrote it, offered as the scrub schedule.

modestring
hourstring
dayOfMonthstring
daystring
monthstring
frequencystring
correctingbooleanrequired
scrubReportOnlyboolean

True when Unraid's parity check wrote no corrections, which maps to a scrub that only reports.

spindownDelaystring

Unraid's global spin-down delay, offered as the default.

scripts object[]

The User Scripts the scan found, on user_scripts only. Empty when the scan found none or could not say; the report's User Scripts row tells which.

  • Array [
  • namestringrequired
    schedulestring

    The schedule the plugin's customSchedule.cron gives it, absent when it has none there.

  • ]
  • MigrationChecklistItem
    {
    "id": "appdata_cache",
    "status": "todo",
    "acknowledgeable": true,
    "doneAt": "2024-07-29T15:51:28.071Z",
    "jobId": "string",
    "acknowledgedBy": "string",
    "acknowledgedAt": "2024-07-29T15:51:28.071Z",
    "notifications": {
    "channels": 0,
    "tested": 0,
    "agents": [
    "string"
    ]
    },
    "schedules": {
    "mover": true,
    "sync": true,
    "scrub": true,
    "chainStartTime": "string",
    "weeklyScrubDay": 0,
    "offers": {
    "moverCron": "string",
    "moverTime": "string",
    "parityCheck": {
    "mode": "string",
    "hour": "string",
    "dayOfMonth": "string",
    "day": "string",
    "month": "string",
    "frequency": "string",
    "correcting": true
    },
    "scrubReportOnly": true,
    "spindownDelay": "string"
    }
    },
    "scripts": [
    {
    "name": "string",
    "schedule": "string"
    }
    ]
    }