onebackupjob
- manages OpenNebula Backup Jobs
onebackupjob
command [args] [options]
--adjust x,y,z Adjust size to not truncate selected columns
--admin lock admin actions
--all lock all actions
-a, --append Append new attributes to the current template
--vms "vm_id1,vm_id2..." List of VM IDs to backup
--csv Write table in csv format
--csv-del del Set delimiter for csv output
-d, --delay x Sets the delay in seconds for top command
--describe Describe list columns
--description description Description for the new Image
--end number|TIME ----
--endpoint endpoint URL of OpenNebula xmlrpc frontend
--expand [x=prop,y=prop] Expands the columns size to fill the terminal.
For example: $onevm list --expand
name=0.4,group=0.6 will expand name 40% and
group 60%. $onevm list --expand name,group will
expand name and group based on its size.$onevm
list --expand will expand all columns.
-f, --filter x,y,z Filter data. An array is specified with
column=value pairs. Valid operators
=,!=,<,<=,>,>=,~ e.g. NAME=test (match name with
test) NAME~test (match every NAME containing the
substring 'test')
-h, --help Show this message
--hourly hour Repeats the schedule action with the given hourly
frequency. For example (every 5 hours): onevm
resume 0 --schedule "09/23 14:15" --hourly 5
-j, --json Show the resource in JSON format
--keep N Keep N backups for the VMs in this backup job
-l, --list x,y,z Selects columns to display with list command
-c, --listconf conf Selects a predefined column list
--manage lock manage actions
--mode <increment|full> Backup mode
--monthly days Repeats the schedule action the days of the month
specified, it can be a number between 1,31
separated with commas. For example: onevm resume
0 --schedule "09/23 14:15" --monthly 1,14
--name name Name of the new backup job
--no-expand Disable expand
--no-header Hides the header of the table
--no-pager Disable pagination
-n, --numeric Do not translate user and group IDs
--operator operator Logical operator used on filters: AND, OR.
Default: AND.
--password password Password to authenticate with OpenNebula
--schedule TIME Schedules this action to be executed afterthe
given time. For example: onevm resume 0
--schedule "09/23 14:15"
-s, --size x=size,y=size Change the size of selected columns. For example:
$ onevm list --size "name=20" will make column
name size 20.
--use lock use actions
--user name User name used to connect to OpenNebula
-v, --verbose Verbose mode
-V, --version Show version and copyright information
--weekly days Repeats the schedule action the days of the week
specified, it can be a number between 0 (Sunday)
to 6 (Saturday) separated with commas. For
example: onevm resume 0 --schedule "09/23 14:15"
--weekly 0,2,4
-x, --xml Show the resource in xml format
-y, --yaml Show the resource in YAML format
--yearly days Repeats the schedule action the days of the year
specified, it can be a number between 0,365
separated with commas. For example: onevm resume
0 --schedule "09/23 14:15" --yearly 30,60
backup range|backupjobid_list Start the Backup Job execution. valid options: end, hourly, monthly, schedule, weekly, yearly
cancel range|backupjobid_list Cancel pending Backup Job, remove Virtual Machines from the outdated list, call cancel action on all ongoing VM backup operations.
chgrp range|backupjobid_list groupid Changes the Backup Job group
chmod range|backupjobid_list octet Changes the BackupJob permissions
chown range|backupjobid_list userid [groupid] Changes the Backup Job owner and group
create [file] Creates a new Backup Job Examples:
- using a template description file:
onebackupjob create weekly_backup.tmpl
valid options: backup_vms, description, end, hourly, keep_last, mode, monthly, name, schedule, weekly, yearly
delete range|backupjobid_list Deletes the given Backup Job
list [filterflag] Lists Backup Jobs in the pool. The default columns and their layout can be configured in onebackupjob.yaml valid options: adjust, csv, csv_del, delay, describe, expand, filter, json, list, listconf, no_expand, no_header, no_pager, numeric, operator, size, xml, yaml
lock range|backupjobid_list Locks a Backup Job to prevent certain actions defined by different levels. The show action will never be locked. Levels: [Use]: locks Admin, Manage and Use actions. [Manage]: locks Manage and Use actions. [Admin]: locks only Admin actions. valid options: admin, all, manage, use
priority range|backupjobid_list priority Change the priority of the Backup Job. Only oneadmin may increase priority over 50.
rename backupjobid name Renames the Backup Job
retry range|backupjobid_list Retry failed Backup Job. Trigger backup for Virtual Machines from error list.
sched-delete bjid schedid Remove a Scheduled Action from the Backup Job.
sched-update bjid schedid [file] Update a Scheduled Action for the Backup Job.
show backupjobid Shows information for the given Backup Job valid options: json, xml, yaml
unlock range|backupjobid_list Unlocks an Backup Job.
update backupjobid [file] Update the Backup Job contents. If a path is not provided the editor will be launched to modify the current content. valid options: append
backupjobid OpenNebula BACKUPJOB name or id
backupjobid_list Comma-separated list of OpenNebula BACKUPJOB names or ids
file Path to a file
filterflag a, all all the known BACKUPJOBs m, mine the BACKUPJOB belonging to the user in ONE_AUTH g, group 'mine' plus the BACKUPJOB belonging to the groups the user is member of G, primary group the BACKUPJOB owned the user's primary group uid BACKUPJOB of the user identified by this uid user BACKUPJOB of the user identified by the username
groupid OpenNebula GROUP name or id
range List of id's in the form 1,8..15
text String
userid OpenNebula USER name or id
OpenNebula 6.8.0 Copyright 2002-2023, OpenNebula Project, OpenNebula Systems