kyvernon backup

`kyvernon backup`

Backup sessions, changed-block areas and restores

Usage

kyvernon backup <COMMAND>

Subcommands: info, sessions, invalidate, restores, verification, repository, points, delete-point, restore-point, settings, schedules

`kyvernon backup info`

Backup service capabilities

Usage

kyvernon backup info

API operation: GET /v1/backup/info

`kyvernon backup sessions`

Backup sessions

Usage

kyvernon backup sessions <COMMAND>

Subcommands: list, begin, get, changed-areas, keepalive, end

`kyvernon backup sessions list`

List sessions, newest first

Usage

kyvernon backup sessions list [OPTIONS]

Argument	Description	Required
`--vm`	Only sessions of this VM instance UUID

API operation: GET /v1/backup/sessions

`kyvernon backup sessions begin`

Begin a session from a JSON body (BeginBackupRequest schema)

Usage

kyvernon backup sessions begin [OPTIONS]

Argument	Description	Required
`--body`	Inline JSON body
`--body-file`	File with the JSON body (`-` for stdin)

API operation: POST /v1/backup/sessions

`kyvernon backup sessions get`

One session

Usage

kyvernon backup sessions get <ID>

Argument	Description	Required
`<ID>`	Session id	yes

API operation: GET /v1/backup/sessions/{id}

`kyvernon backup sessions changed-areas`

Changed areas of a disk in a session

Usage

kyvernon backup sessions changed-areas [OPTIONS] <ID> <DEVICE_KEY>

Argument	Description	Required
`<ID>`	Session id	yes
`<DEVICE_KEY>`	Disk device key	yes
`--start-offset`	Byte offset
`--max-areas`	Page size

API operation: GET /v1/backup/sessions/{id}/disks/{deviceKey}/changed-areas

`kyvernon backup sessions keepalive`

Extend a session's deadline

Usage

kyvernon backup sessions keepalive <ID>

Argument	Description	Required
`<ID>`	Session id	yes

API operation: POST /v1/backup/sessions/{id}/keepalive

`kyvernon backup sessions end`

End a session

Usage

kyvernon backup sessions end [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Session id	yes
`--outcome`	`SUCCESS` or `FAILURE` default `SUCCESS`

API operation: POST /v1/backup/sessions/{id}/end

`kyvernon backup invalidate`

Restart change tracking of a disk (InvalidateRequest body)

Usage

kyvernon backup invalidate [OPTIONS] <DISK_ID>

Argument	Description	Required
`<DISK_ID>`	Stable disk id	yes
`--vm`	VM instance UUID	yes
`--reason`	Reason	yes

API operation: POST /v1/backup/disks/{diskId}/invalidate

`kyvernon backup restores`

Restores into a new disk, and restore verification in quarantine

Usage

kyvernon backup restores <COMMAND>

Subcommands: begin, finish, verify, get

`kyvernon backup restores begin`

Begin a restore from a JSON body (BeginRestoreRequest schema)

Usage

kyvernon backup restores begin [OPTIONS]

Argument	Description	Required
`--body`	Inline JSON body
`--body-file`	File with the JSON body (`-` for stdin)

API operation: POST /v1/backup/restores

`kyvernon backup restores finish`

Finish a restore: commit or discard the written disk

Usage

kyvernon backup restores finish [OPTIONS] <VM> <DEVICE_KEY>

Argument	Description	Required
`<VM>`	Target VM instance UUID	yes
`<DEVICE_KEY>`	Device key	yes
`--discard`	Discard instead of commit

API operation: POST /v1/backup/restores/{vmId}/disks/{deviceKey}/finish

`kyvernon backup restores verify`

Verify a restored VM in a quarantine network: power on, judge boot, DHCP lease and console, power off. Prints the running session; poll it with restores get

Usage

kyvernon backup restores verify [OPTIONS] <VM>

Argument	Description	Required
`<VM>`	Restored VM instance UUID (all its NICs on the quarantine network)	yes
`--network`	Quarantine network, id or name	yes
`--timeout`	Give up after this many seconds
`--destroy`	Destroy the VM after the verdict

API operation: POST /v1/backup/restores/{vmId}/verify

`kyvernon backup restores get`

The verification state of a restored VM

Usage

kyvernon backup restores get <VM>

Argument	Description	Required
`<VM>`	Restored VM instance UUID	yes

API operation: GET /v1/backup/restores/{vmId}

`kyvernon backup verification`

The nightly restore verification report and its manual run

Usage

kyvernon backup verification <COMMAND>

Subcommands: report, run

`kyvernon backup verification report`

Last verification run per VM (verdict, evidence, flagged VMs never verified)

Usage

kyvernon backup verification report

API operation: GET /v1/backup/verification

`kyvernon backup verification run`

Run the nightly verification now, in the background

Usage

kyvernon backup verification run

API operation: POST /v1/backup/verification/run

`kyvernon backup repository`

The backup repository: configured or not, number of backup points

Usage

kyvernon backup repository

API operation: GET /v1/backup/repository

`kyvernon backup points`

Backup points in the repository, newest first

Usage

kyvernon backup points [OPTIONS]

Argument	Description	Required
`--vm`	Only the points of this VM (`vm-N`)

API operation: GET /v1/backup/points

`kyvernon backup delete-point`

Delete a backup point from the repository

Usage

kyvernon backup delete-point <ID>

Argument	Description	Required
`<ID>`	Backup point id	yes

API operation: DELETE /v1/backup/points/{id}

`kyvernon backup restore-point`

Restore a backup point to a new VM, or into its powered-off VM (--in-place)

Usage

kyvernon backup restore-point [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Backup point id	yes
`--in-place`	Replace the disks of the VM the point came from (it must be powered off)
`--verify-network`	Verify the point in quarantine afterwards, on this quarantine network
`--name`	Name of the new VM (default: `<source> (restored)`)
`--datastore`	Datastore for the disks (default: the verification pool)
`--power-on`	Power the VM on afterwards
`--wait`	Wait for the task

API operation: POST /v1/backup/points/{id}/restore

`kyvernon backup settings`

The backup settings (repository, default quiescing, nightly verification)

Usage

kyvernon backup settings <COMMAND>

Subcommands: get, set

`kyvernon backup settings get`

The settings in force

Usage

kyvernon backup settings get

API operation: GET /v1/backup/settings

`kyvernon backup settings set`

Change settings; options not given keep their value

Usage

kyvernon backup settings set [OPTIONS]

Argument	Description	Required
`--repository`	Repository directory on the controller (absolute; `""` for none)
`--default-quiesce`	Quiescing of backups that do not say: NONE, PREFERRED or REQUIRED
`--verify-schedule`	Nightly verification: `HH:MM` UTC or an interval such as `6h`; `""`: off
`--verify-network`	Quarantine network of the verification
`--verify-timeout`	Timeout of one verification, seconds
`--verify-destroy`	Destroy verification VMs after the verdict (true or false) values `true`, `false`
`--verify-pool`	Datastore restored disks go to (`""`: the first usable one)

API operation: PUT /v1/backup/settings

`kyvernon backup schedules`

Backup schedules

Usage

kyvernon backup schedules <COMMAND>

Subcommands: list, get, create, update, delete, run

`kyvernon backup schedules list`

List schedules

Usage

kyvernon backup schedules list

API operation: GET /v1/backup/schedules

`kyvernon backup schedules get`

One schedule

Usage

kyvernon backup schedules get <ID>

Argument	Description	Required
`<ID>`	Schedule id (`bkschedule-N`)	yes

API operation: GET /v1/backup/schedules/{id}

`kyvernon backup schedules create`

Create a schedule

Usage

kyvernon backup schedules create [OPTIONS] <NAME>

Argument	Description	Required
`<NAME>`	Name	yes
`--scope`	Folder, datacenter, cluster, resource pool, host or VM it covers (inventory id)	yes
`--frequency`	daily or weekly default `daily`
`--hour`	Hour, UTC	yes
`--minute`	Minute default `0`
`--weekday`	Weekday for weekly schedules, 0 is Sunday (repeat)
`--quiesce`	Quiescing: NONE, PREFERRED or REQUIRED default `PREFERRED`
`--full-every`	A full transfer every n points default `7`
`--retention`	Points kept per VM (0: all) default `14`
`--disabled`	Create or keep it switched off

API operation: POST /v1/backup/schedules

`kyvernon backup schedules update`

Change a schedule (the whole definition)

Usage

kyvernon backup schedules update [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Schedule id	yes
`--name`	Name	yes
`--scope`	Folder, datacenter, cluster, resource pool, host or VM it covers (inventory id)	yes
`--frequency`	daily or weekly default `daily`
`--hour`	Hour, UTC	yes
`--minute`	Minute default `0`
`--weekday`	Weekday for weekly schedules, 0 is Sunday (repeat)
`--quiesce`	Quiescing: NONE, PREFERRED or REQUIRED default `PREFERRED`
`--full-every`	A full transfer every n points default `7`
`--retention`	Points kept per VM (0: all) default `14`
`--disabled`	Create or keep it switched off

API operation: PUT /v1/backup/schedules/{id}

`kyvernon backup schedules delete`

Delete a schedule; its backup points stay

Usage

kyvernon backup schedules delete <ID>

Argument	Description	Required
`<ID>`	Schedule id	yes

API operation: DELETE /v1/backup/schedules/{id}

`kyvernon backup schedules run`

Run a schedule now

Usage

kyvernon backup schedules run <ID>

Argument	Description	Required
`<ID>`	Schedule id	yes

API operation: POST /v1/backup/schedules/{id}/run