CLI Reference

Overview

Every node provides CLI that can be used to manage configuration and invoke tasks on Storware Backup & Recovery Node. All of the commands are executed using vprotect command. The general syntax is as shown below:

[root@vProtect3 ~]# vprotect
usage: vprotect <COMMAND> -<ARG_1> ... -<ARG_N>
COMMAND is one of the following:
 node                   Node management
 config                     Node configuration management
 hv                         Hypervisor management
 hvm                        Hypervisor manager management
 hc                         Hypervisor cluster management
 hs                         Hypervisor storage management
 vm                         Virtual machine management
 vmpolicy                   VM backup policy management
 bd                         Backup destination management
 sched                      Schedule management
 brvm                       VM backup & restore
 st                         Storage management
 stpool                     Storage pool management
 stprovider                  Storage provider management
 brapp                      Application backup & restore
 mnt                        Mounted backup management
 task                       Task management
 login                      User login
 logout                     Node and user logout
 stop                       Safely stops node
 vm-snappolicy              Snapshot policy management for VMs
 storage-snappolicy          Snapshot policy management for storages
 app                        Application backup management
 appconf                    App command execution management
 apppolicy                  Application backup policy management
 restorejob                  Restore jobs
 recplan                    Recovery plan policies
 brst                       Storage backup & restore
 quota                      Quota management
 project                    Project management
 user                       User management
 rbac                       Rbac management
 role                       AppUser Role management
 group                      AppUser Group management
 status                     Shows node status
 start                      Starts node

Starting and stopping node

  • To check if Storware Backup & Recovery Node is running, run:

    systemctl status vprotect-node

    or

    vprotect status
  • To start Storware Backup & Recovery Node run:

    systemctl start vprotect-node

    or

    vprotect start
  • To safely stop Storware Backup & Recovery Node (this command waits for all tasks to be canceled, so that temporary objects are cleaned up) run:

    systemctl stop vprotect-node

    or

    vprotect stop
  • In emergency cases you may need to kill the engine without task clean up - get PID of the node by running:

    vprotect status

    and kill process using:

    kill <PID>

User login

  • To log in to CLI use the following command:

    vprotect login -u USER_NAME

where USER_NAME is your admin account in Storware Backup & Recovery. You will be prompted for a password. From this moment you are able to execute commands.

  • Once you completed working with CLI, you can log out by running:

    vprotect logout -u

Note about GUIDs

All of the commands require GUID of the object that you want to refer to in the command. GUID is found in the first column of typical list command, e.g.:

  1. Let's list VMs and get VM GUID:

     [root@vProtect3 ~]# vprotect vm -l
                     GUID                              Name                   Hypervisor       Present   VM group    Protected       Last backup        
     ------------------------------------  -----------------------------  -------------------  -------  -----------  ---------  ----------------------  
     b2555a74-97bb-44e4-9c68-ed1ac2ddffcd  Windows 7 (32-bit)            xcp-ng.storware.local  true    PM-T1_Group  false      2020-06-03 00:30 (Tue)
  2. Now let's show details of the VM:

    [root@vprotect ~]# vprotect vm -g b2555a74-97bb-44e4-9c68-ed1ac2ddffcd
    Property                                      Value                                                                             
    --------------------------------------------  ------------------------------------------------------------  
    
    GUID                                          b2555a74-97bb-44e4-9c68-ed1ac2ddffcd  
    Name                                          Windows 7 (32-bit)  
    UUID                                          9a486d85-c5c6-868b-50f4-3b27f4e4f968  
    Present                                       true  
    HV type                                       CITRIX  
    HVM type                                      -  
    Inc. backup snapshot                          Windows 7 (32-bit): 2020-06-15 19:10:22.0 (6626e7d9-0900-4bfa-a961-85f5379b48d4)  
    Tags                                          [vPro-Citrix]  
    Hypervisor                                    10.40.0.29 (1048d561-b0f5-4f1d-b558-856b28e0283e)  
    HV manager                                    -  
    Backups                                       29  
    VM backup policies                            Citrix Hypervisor | XCP-ng (1f02821f-75f9-433f-9698-5694f130e1df)  
    Protected                                     true  
    Last backup                                   2020-06-15 19:10 (Mon)  
    Warnings present                              true  
    VM export/import mode                         INHERIT  
    Quiesce/freeze before snapshot                false  
    SSH host                                      -  
    SSH port                                      22  
    SSH user                                      -  
    SSH key path                                  -  
    Pre-snapshot CMD exec. enabled                false  
    Pre-snapshot CMD                              []  
    Post-snapshot CMD exec. enabled               false  
    Post-snapshot CMD                             []  
    Pre-snapshot ignored exit codes               -  
    Pre-snapshot standard error output handling   DONT_IGNORE  
    Post-snapshot ignored exit codes              -  
    Post-snapshot standard error output handling  DONT_IGNORE

Note: that UUID is the ID used by the hypervisor or HV manager, while GUID is the ID used by Storware Backup & Recovery to uniquely identify objects.

Node GUID can be replaced by this keyword to state that action such as restore or mount is going to be run on the node where the command is executed from. For instance, to restore or backup with given GUID on current node to /vprotect_data:

vprotect br -r 2132182d-e9ab-4478-a1db-48222b0e515b this /vprotect_data

Similarly, backup destinations can be referred to by names. So a backup of some VM with given GUID to backup destination with name ISP can be done like this:

vprotect br -b b6f96d43-6f55-468f-a7a0-8aa6219fdf4e ISP

Nodes

To list or register node use vprotect node sub-command:

[root@vprotect ~]# vprotect node
Incorrect syntax: Missing required option: [-r Register node, -R Check and Register node, -d Delete node, -e Register existing node, -l List nodes]

usage: node -d <GUID | NAME> | -e <NODE_NAME> <ADMIN_LOGIN> <API_URL> <[PASSWORD]> | -l | -r <NODE_NAME> <ADMIN_LOGIN> <API_URL> <[PASSWORD]> | -R <NODE_NAME> <ADMIN_LOGIN> <API_URL> <[PASSWORD]>
Node management
 -d,--delete <GUID | NAME>                                                  Delete node
 -e,--register-existing <NODE_NAME> <ADMIN_LOGIN> <API_URL> <[PASSWORD]>    Register existing node
 -l,--list                                                                  List nodes
 -r,--register <NODE_NAME> <ADMIN_LOGIN> <API_URL> <[PASSWORD]>             Register node
 -R,--check-and-register <NODE_NAME> <ADMIN_LOGIN> <API_URL> <[PASSWORD]>   Check and Register node

Examples

  • To list all nodes registered

    vprotect node -l
  • Example node registration

    vprotect node -r node1 admin https://localhost:8181/api
  • You may need to re-register a node if Storware Backup & RecoveryServer address changes

    vprotect node -e node1 admin https://localhost:8181/api

Node configurations

Use vprotect config sub-command add/remove backup destinations from node config, list, or show details of node configs.

[root@dell-emc-vprotect ~]# vprotect config
Incorrect syntax: Missing argument for option: s

usage: config -b <CONFIG_GUID> <[BD_GUID|BD_NAME],...,[BD_GUID|BD_NAME]> | -c <NAME> | -d <GUID> | -g <GUID> | -l | -r <CONFIG_GUID> <[BD_GUID|BD_NAME],...,[BD_GUID|BD_NAME]> | -s <GUID> <PROPERTY_NO.> <VALUE | "MAPPING1=VALUE1;MAPPING2=VALUE2">

Node configuration management
 -b,--add-backup-destinations <CONFIG_GUID> <[BD_GUID|BD_NAME],...,[BD_GUID|BD_NAME]>      Add backup destinations
 -c,--create <NAME>                                                                        Create node config
 -d,--delete <GUID>                                                                        Delete node config
 -g,--details <GUID>                                                                       Show config details
 -l,--list                                                                                 List node configs
 -r,--remove-backup-destinations <CONFIG_GUID> <[BD_GUID|BD_NAME],...,[BD_GUID|BD_NAME]>   Remove backup destinations
 -s,--set <GUID> <PROPERTY_NO.> <VALUE | "MAPPING1=VALUE1;MAPPING2=VALUE2">                Modify node config.

Setting up parameters for node configuration

In general vprotect config -s <GUID> <PROPERTY_NO.> <VALUE> the command sets the value of a property with the given number of node configurations with GUID. Property numbers are returned in a detailed view of each node configuration. After you create node configuration, show default values with -g. Then use property numbers (the first number in the property/value line of the detailed view).

Examples

  • To list all node configurations

    vprotect config -l
    
                    GUID                       Name       Default  Nodes  Backup destinations  Modification time  
    ------------------------------------  --------------  -------  -----  -------------------  -----------------  
    c95fb3cc-e567-11eb-8446-566fc400002d  Default Config  true     1      1                    2021-07-16 11:41
  • To show details of the given node config (by GUID)

    vprotect config -g c95fb3cc-e567-11eb-8446-566fc400002d
    
    Property                                                     Value                                                         
    -----------------------------------------------------------  ------------------------------------------------------------  
    
    GUID                                                         c95fb3cc-e567-11eb-8446-566fc400002d  
    Modification time                                            2021-07-16 11:41:54  
    1. Name                                                      Default Config  
    2. Default                                                   true  
    3. Export path                                               /vprotect_data  
    4. Import path                                               /vprotect_data/import  
    5. Mount path                                                /vprotect_data/mount  
    6. Max. backup time diff. [sec.]                             60  
    7. Keep last backups locally                                 false  
    8. Min. free space for export (staging space threshold) [%]  10  
    9. Minimal free space for snapshot in bytes                  0  
    10. Minimal free space for snapshot in percentages           0  
    11. Max. no. of inventory synchronization threads            1  
    12. Max. no. of export threads                               3  
    13. Max. no. of export threads                               3  
    14. Max. no. of export threads per source                    2  
    15. Max. no. of store threads                                3  
    16. Max. no. of restore threads                              3  
    17. Inventory synchronization task timeout [min.]            1h   
    18. Export task timeout [min.]                               5h   
    19. Store task timeout [min.]                                5h   
    20. Restore task timeout [min.]                              1h   
    21. Unmount task timeout [min.]                              1h   
    22. Mount task timeout [min.]                                1h   
    23. Import task timeout [min.]                               1h   
    24. Old backups removal task timeout [min.]                  1h   
    25. Snapshot reversion task timeout [min.]                   1h   
    26. Old snapshot removal task timeout [min.]                 1h   
    27. Task snapshot timeout [min.]                             1h   
    28. Max. no. of snapshot threads                             5  
    29. Max. no. of snapshots threads per source                 2  
    Backup destinations                                          [backup [FILESYSTEM] (bb0524fe-40a1-4ca3-bbc9-7f0be8ac73cc)]
  • To add backup destination (second GUID) to the given node configuration (first GUID):

    vprotect config -b c95fb3cc-e567-11eb-8446-566fc400002d f27b6018-ce1c-4d67-991e-31d9f4f6662b

    More backup destinations can be added by separating GUIDs with commas.

Backup destinations

The backup destination management module is used to add and remove a backup destination (a backup provider instance with retention settings). A backup destination must be assigned to a group for the scheduler to know where to put backups during automatic backup. For on-demand backup, you just need to specify which backup destination should be used.

Backup destinations are assigned to the node configuration. This means that nodes using such configuration are configured to store backups in the selected backup destinations.

Note: that the backup task will fail if it is not able to assign a node because the given BD is not assigned to the node config of the node that is required to be used for the given hypervisor.

To manage backup destinations in the system used vprotect bd sub-command.

[root@vprotect ~]# vprotect bd
Required option: [-r Reinitialize backup destination, -c Create backup destination (type = ["filesystem", "netbackup", "networker", "s3", "swift", "isp", "azure", "gcs", "avamar"]), -s Modify backup destination, -d Delete backup destination, -D Remove old backups, -g Show backup destination details, -l List backup destinations]

usage: bd -c <NAME> <TYPE> | -d <GUID | NAME> | -D <[GUID | NAME],...,[GUID | NAME]> | -g <GUID | NAME> | -l | -r <[GUID]> | -s <GUID |
       NAME> <PROPERTY_NO.> <VALUE>
Backup destination management
 -c,--create <NAME> <TYPE>                                   Create backup destination (type = ["filesystem", "netbackup", "networker",
                                                             "s3", "swift", "isp", "azure", "gcs", "avamar"])
 -d,--delete <GUID | NAME>                                   Delete backup destination
 -D,--remove-old-backups <[GUID | NAME],...,[GUID | NAME]>   Remove old backups
 -g,--details <GUID | NAME>                                  Show backup destination details
 -l,--list                                                   List backup destinations
 -r,--reinit <[GUID]>                                        Reinitialize backup destination
 -s,--set <GUID | NAME> <PROPERTY_NO.> <VALUE>               Modify backup destination

Setting up parameters for backup destinations

In general vprotect bd -s <GUID> <PROPERTY_NO.> <VALUE> command sets value of property with the given number of BD with GUID. Property numbers are returned in detailed view of each BD (fields obviously are different for each backup provider). After you create backup destination, show default values with -g. Then use property numbers (first number in the property/value line of the detailed view).

Retention time settings are interpreted in days (just give a number without any additional suffixes).

There are however some mode/type fields that require a string to be typed in the correct format:

  1. Amazon S3 - Backup mode - must be either:

    • SINGLE_BUCKET - single bucket for all VMs

    • ONE_BUCKET_PER_VM - separate bucket for each VM (note that default limit is 100 buckets in Amazon S3)

  2. Swift - Auth method - authentication method used to authenticate Swift BD:

    • BASIC

    • TEMPAUTH

    • KEYSTONE

  3. Time zones must be specified in the format shown in this table: List of tz database time zones

Examples

  • To list all backup destinations

    vprotect bd -l
  • To show details of the given HV manager (by GUID) - note that each BD has a different set of fields - numbers at the beginning of a line indicate an identifier of a field you want to set from CLI:

    [root@vprotect ~]# vprotect bd -g 3263b196-056e-4485-9e8f-932798b58eb3
    Property                                                                   Value                                 
    ------------------------------------------------------------  ------------------------------------  
    
    GUID                                                                       bb0524fe-40a1-4ca3-bbc9-7f0be8ac73cc  
    Node configs                                                               1  
    Type                                                                       FILESYSTEM  
    Total available space                                                      181 GiB  
    Total used space                                                           9,1 GiB  
    1. Name                                                                    backup  
    2. Pre-access CMD exec. enabled                                            false  
    3. Pre-access CMD                                                          []  
    4. Post-access CMD exec. enabled                                           false  
    5. Post-access CMD                                                         []  
    6. Default                                                                 false  
    7. Retention (full) - keep last N backups                                  4  
    8. Retention (full) - keep newer than                                      30d   
    9. Retention (inc.) - keep last N backups                                  30  
    10. Retention (inc.) - keep newer than                                     30d   
    11. Paths                                                                  [/backup]  
    12. Deduplication enabled                                                  false  
    13. Deduplication device                                                    -   
    14. Deduplicated filesystem mount point (set as 'default' to use BD path)  /backup  
    15. Deduplication volume used space threshold percentage                    -   
    16. Encryption enabled
  • Remember that to use a BD you need to create a new entry of a given type and then configure its properties (example for IBM Spectrum Protect [ISP], assume that GUID returned by the first command was bb74ef6c-f6de-4783-bfa7-70fc2376fb08 ):

    [root@localhost vprotect]# vprotect bd -c MyTSM isp
    [root@vprotect ~]# vprotect bd -g bb74ef6c-f6de-4783-bfa7-70fc2376fb08
    Property                                   Value                                 
    -----------------------------------------  ------------------------------------  
    
    GUID                                       bb74ef6c-f6de-4783-bfa7-70fc2376fb08  
    Node configs                               1  
    Type                                       ISP  
    Total available space                      -  
    Total used space                           0 B  
    1. Name                                    IBM Spectrum Protect  
    2. Pre-access CMD exec. enabled            false  
    3. Pre-access CMD                          []  
    4. Post-access CMD exec. enabled           false  
    5. Post-access CMD                         []  
    6. Default                                 false  
    7. Retention (full) - keep last N backups  4  
    8. Retention (full) - keep newer than      30d   
    9. Retention (inc.) - keep last N backups  30  
    10. Retention (inc.) - keep newer than     30d   
    11. dsm.opt file path                      /opt/vprotect/dsm.opt  
    12. Node name                              vprotect  
    13. Node password                          ***  
    14. Time zone                              Europe/Sarajevo  
    15. Backup progress refresh rate           20  
    16. Restore progress refresh rate          20

    Now set the properties:

    • retention - full - 4 versions / 30 days

    • retention - incremental - 28 versions / 30 days

    • ISP node name

    • ISP node password

    • ISP server time zone

    vprotect bd -s c1d7fa34-e558-4a1c-af1f-46e88da7bcf5 2 4
    vprotect bd -s c1d7fa34-e558-4a1c-af1f-46e88da7bcf5 3 30
    vprotect bd -s c1d7fa34-e558-4a1c-af1f-46e88da7bcf5 4 28
    vprotect bd -s c1d7fa34-e558-4a1c-af1f-46e88da7bcf5 5 30
    vprotect bd -s c1d7fa34-e558-4a1c-af1f-46e88da7bcf5 7 vprotect
    vprotect bd -s c1d7fa34-e558-4a1c-af1f-46e88da7bcf5 8 vpr0tectPass
    vprotect bd -s c1d7fa34-e558-4a1c-af1f-46e88da7bcf5 9 Europe/Warsaw

HV managers (oVirt/RHV/Oracle VM/Nutanix/Kubernetes)

Hypervisor manager management module is used to add, remove hypervisor managers (currently only oVirt and RHV managers) and invoke indexing task. Indexing tasks gathers information about hypervisors and VMs running in the managed environment and updates their location if the VM has been moved to the different hypervisor.

To manage HV managers in the system usedvprotect hvm sub-command.

Note: that if you're using RHV/oVirt/Oracle VM/Nutanix/Kubernetes then hypervisors will be detected automatically as a part of the index task. So there is no need to define every hypervisor manually as they will be detected automatically.

[root@vprotect ~]# vprotect hvm
Incorrect syntax: Missing required option: [-c Create hypervisor manager (type = ["rhev", "rhv", "ovm", "nutanix", "openstack"]), -d Delete hypervisor manager, -e Set export/import mode for HV manager, -g Show HV manager details, -l List hypervisor managers, -L List hypervisors managed by hypervisor manager, -m Modify hypervisor manager, -n Set node config for hypervisor, -sC Modify hypervisor manager configuration, -s Index inventory on hypervisor manager, -u Set user/password or access key/secret key, -V List VMs managed by hypervisor manager, -sK Set SSH key path]

usage: hvm -c <URL | ACCOUNT_ID> <TYPE> | -d <GUID | HOST> | -e <GUID | HOST> <DEFAULT|DISK_ATTACHMENT|DISK_IMAGE_TRANSFER|SSH_TRANSFER> | -g <GUID | HOST> | -l | -L <GUID | HOST> | -m <GUID | HOST> <URL> | -n <GUID | HOST> <NODE_CONFIG_GUID | NODE_CONFIG_NAME> | -s <GUID | HOST> |
       -sC <GUID> <PROPERTY_NO.> <VALUE | "MAPPING1=VALUE1;MAPPING2=VALUE2"> | -sK <GUID> <SSH_KEYPATH> | -u <GUID | HOST> <USER/ACCESS_KEY> <PASSWORD/SECRET_KEY> | -V <GUID | HOST>
Hypervisor manager management
 -c,--create <URL | ACCOUNT_ID> <TYPE>                                                                  Create hypervisor manager (type = ["rhev", "rhv", "ovm", "nutanix", "openstack"])
 -d,--delete <GUID | HOST>                                                                              Delete hypervisor manager
 -e,--set-export-import-mode <GUID | HOST> <DEFAULT|DISK_ATTACHMENT|DISK_IMAGE_TRANSFER|SSH_TRANSFER>   Set export/import mode for HV manager
 -g,--details <GUID | HOST>                                                                             Show HV manager details
 -l,--list                                                                                              List hypervisor managers
 -L,--list-hvs <GUID | HOST>                                                                            List hypervisors managed by hypervisor manager
 -m,--modify <GUID | HOST> <URL>                                                                        Modify hypervisor manager
 -n,--set-node-config <GUID | HOST> <NODE_CONFIG_GUID | NODE_CONFIG_NAME>                               Set node config for hypervisor
 -s,--sync <GUID | HOST>                                                                                Index inventory on hypervisor manager
 -sC,--configuration <GUID> <PROPERTY_NO.> <VALUE | "MAPPING1=VALUE1;MAPPING2=VALUE2">                  Modify hypervisor manager configuration
 -sK,--set-ssh-key-path <GUID> <SSH_KEYPATH>                                                            Set SSH key path
 -u,--credentials <GUID | HOST> <USER/ACCESS_KEY> <PASSWORD/SECRET_KEY>                                 Set user/password or access key/secret key
 -V,--list-vms <GUID | HOST>

Examples

  • To list all hypervisor managers

    vprotect hvm -l
  • To show details of the given HV manager (by GUID)

    vprotect hvm -g 4c999c85-e223-4df3-9c40-7b0115234c8c
  • To index VMs and hypervisors on the given HV manager:

    vprotect hvm -s 4c999c85-e223-4df3-9c40-7b0115234c8c
  • To create a HV manager you need to execute the following commands:

    • Create HV manger entry with given type:

      vprotect hvm -c https://dovirt-m.lab.local/ovirt-engine/api/v3 rhev
    • Use GUID returned to set credentials:

      vprotect hvm -u 4c999c85-e223-4df3-9c40-7b0115234c8c admin@internal password
    • By default current node configuration is used for created HV manager - you may change it with this command (first HV GUID, then node configuration GUID):

      vprotect hvm -n 4c999c85-e223-4df3-9c40-7b0115234c8c e2673e8f-66fc-4e9f-aaef-20958c4c2b01

      Hypervisors connected to the HV manager will have node configuration of the HV manager assigned by default. For backup export always node configuration assigned to the HV is used.

Hypervisors

The Hypervisor management module is used to add, remove hypervisors and invoke indexing tasks. Indexing tasks gather information about VMs running on the hypervisor and update their location if the VM has been moved within the pool.

To manage hypervisors in the system used vprotect hv sub-command.

Note: that if you're using RHV/oVirt/Oracle VM then hypervisors will be detected automatically as a part of the index task. So there is no need to define OVM hypervisors and for RHV/oVirt KVM hosts will be detected automatically.

[root@vprotect ~]# vprotect hv
Incorrect syntax: Missing required option: [-sC Modify hypervisor configuration, -c Create hypervisor (type = ["citrix", "nutanix", "proxmox", "ovm", "kvm", "xen"]), -s Synchronize inventory with hypervisor, -d Delete hypervisor, -nC Set node config for hypervisor, -e Set export/import mode for hypervisor, -u Set user/password, -g Show hypervisor details, -sK Set SSH key path, -l List hypervisors, -L List VMs for hypervisor, -m Modify hypervisor]

usage: hv -c <HOST> <TYPE> | -d <GUID | HOST> | -e <GUID | HOST> <DEFAULT|VM_IMAGE_PLUS_INCREMENTAL_DISKS|CHANGED_BLOCK_TRACKING|SSH_TRANSFER|EXPORT_STORAGE_REPO> | -g <GUID | HOST> | -l | -L <GUID | HOST> | -m <GUID | HOST> <NEW_HOST> | -nC <GUID | HOST> <NODE_CONFIG_GUID> | -s
       <GUID | HOST> | -sC <GUID> <PROPERTY_NO.> <VALUE> | -sK <GUID> <SSH_KEYPATH> | -u <GUID | HOST> <USER> <PASSWORD>

Hypervisor management
 -c,--create <HOST> <TYPE>                                                                                                                     Create hypervisor (type = ["citrix", "nutanix", "proxmox", "ovm", "kvm", "xen"])
 -d,--delete <GUID | HOST>                                                                                                                     Delete hypervisor
 -e,--set-export-import-mode <GUID | HOST> <DEFAULT|VM_IMAGE_PLUS_INCREMENTAL_DISKS|CHANGED_BLOCK_TRACKING|SSH_TRANSFER|EXPORT_STORAGE_REPO>   Set export/import mode for hypervisor
 -g,--details <GUID | HOST>                                                                                                                    Show hypervisor details
 -l,--list                                                                                                                                     List hypervisors
 -L,--list-vms <GUID | HOST>                                                                                                                   List VMs for hypervisor
 -m,--modify <GUID | HOST> <NEW_HOST>                                                                                                          Modify hypervisor
 -nC,--set-node-config <GUID | HOST> <NODE_CONFIG_GUID>                                                                                        Set node config for hypervisor
 -s,--sync <GUID | HOST>                                                                                                                       Synchronize inventory with hypervisor
 -sC,--configuration <GUID> <PROPERTY_NO.> <VALUE>                                                                                             Modify hypervisor configuration
 -sK,--set-ssh-key-path <GUID> <SSH_KEYPATH>                                                                                                   Set SSH key path
 -u,--credentials <GUID | HOST> <USER> <PASSWORD>                                                                                              Set user/password

Examples

  • To list all hypervisors

    vprotect hv -l
  • To show details of the given hypervisor (by GUID)

    vprotect hv -g c93140b8-a898-4aff-8eef-645587ca8289
  • To index VMs on the given HV:

    vprotect hv -s c93140b8-a898-4aff-8eef-645587ca8289
  • To create a hypervisor you need to execute the following commands:

    • Create HV entry with given type:

      vprotect hv -c 1.2.3.4 citrix
    • Use GUID returned to set credentials:

      vprotect hv -u a757c6e8-ece0-467b-b912-dfe393d1e421 root password
    • By default current node configuration is used for created hypervisor - you may change it with this command (first HV GUID, then node configuration GUID):

      vprotect hv -n a757c6e8-ece0-467b-b912-dfe393d1e421 e2673e8f-66fc-4e9f-aaef-20958c4c2b01

Hypervisor clusters

Hypervisor clusters management module enables you to view and remove clusters detected on RHV/oVirt/Nutanix/OVM/XenServer environments.

To view or delete them use vprotect hc sub-command.

[root@localhost ~]# vprotect hc
Incorrect syntax: Missing required option: [-d Delete HV cluster, -l List HV clusters]

usage: hc -d <GUID> | -l
Hypervisor cluster management
 -d,--delete <GUID>                                             Delete HV cluster
 -l,--list                                                      List HV clusters
 -sn,--set-name <GUID> <NAME>                                   Change Hypervisor Cluster name
 -sp,--set-storage-provider <GUID> <STORAGE_PROVIDER_GUID>>     Assign Storage Provider to Hypervisor Cluster. No value unassigns Storage Provider

Examples

  • To list all detected clusters:

    vprotect hc -l
  • To delete a cluster with GUID 107bc87a-9adf-4d6c-b732-345dd06c59e9:

    vprotect hc -d 107bc87a-9adf-4d6c-b732-345dd06c59e9

Hypervisor storage

Hypervisor storage management module enables you to view and remove storage detected on RHV/oVirt/Nutanix/OVM/XenServer environments. You can select storage in the restore dialog box for XenServer/Nutanix and RHV/oVirt (v4) platforms.

To view or delete them used vprotect hs sub-command.

[root@localhost ~]# vprotect hs
Incorrect syntax: Missing required option: [-d Delete HV storage, -l List HV storage]

usage: hs -d <GUID> | -l
Hypervisor storage management
 -d,--delete <GUID>   Delete HV storage
 -l,--list            List HV storage

Examples

  • To list all detected storage volumes:

    vprotect hs -l
  • To delete a storage volume with GUID 6b5aa45a-5436-47cd-82ce-1c4250742323:

    vprotect hs -d 6b5aa45a-5436-47cd-82ce-1c4250742323

Virtual machines

The Virtual machine management module is used to provide information about VMs that has been detected on hypervisors, report the status of the last backup of your VMs (and all backups for a particular VM) and set priority for operations invoked on VM.

To manage VMs in the system used vprotect vm sub-command.

VMs are detected automatically during Index tasks executed on the HV or HV manager.

[root@vprotect ~]# vprotect vm
Incorrect syntax: Missing required option: [-A Assign VM to the policy, -D List detected VM disks, -xC Set pre-snapshot CMD as semi-colon-separated string, i.e. "cmd;-a;-b", -wb Acknowledge warnings related to the backup, -L List backups of the VM, -xE Set pre-snapshot CMD exec enabled (1) / disabled (0), -rvS Revert snapshot, -cS Create VM snapshot, -se Set handling for pre-snap standard error. Values: DONT_IGNORE, IGNORE_WITH_WARNING, IGNORE_WITHOUT_WARNING, -S List managed VM snapshots, -T List tasks related to the VM, -si Set pre-snap ignored command exit codes e.g. '15, 101-150' or '*', -gb Show backup details, -d Delete VM, -g Show virtual machine details, -XC Set post-snapshot CMD as semi-colon-separated string, i.e. "cmd;-a;-b", -l List VMs, -XE Set post-snapshot CMD exec enabled (1) / disabled (0), -sC Set SSH access credentials, -sE Set handling for post-snap standard error. Values: DONT_IGNORE, IGNORE_WITH_WARNING, IGNORE_WITHOUT_WARNING, -sH Set SSH access host/port, -sI Set post-snap ignored command exit codes e.g. '15, 101-150' or '*', -w Acknowledge all backup warnings related to the VM, -sK Set SSH key path, -rmS Remove old snapshots, -eD Exclude disk from backup excluded (1) / included (0)]

usage: vm -A <GUID> <VM_POLICY_GUID> | -cS <GUID> <RULE_GUID> <PRIORITY> | -D <GUID> | -d <GUID> | -eD <DISK_GUID> <0|1> | -g <<VM_GUID>> | -gb <BACKUP_GUID> | -L <GUID> | -l | -rmS <VM_GUID,...,VM_GUID> | -rvS <SNAPSHOT_GUID> | -S <GUID> | -sC <GUID> <SSH_USER> <SSH_PASS> | -se
       <GUID> <HANDLING> | -sE <GUID> <HANDLING> | -sH <GUID> <SSH_HOST> <SSH_PORT> | -si <GUID> <IGNORED_EXIT_CODES> | -sI <GUID> <IGNORED_EXIT_CODES> | -sK <GUID> <SSH_KEYPATH> | -T <GUID> | -w <GUID> | -wb <BACKUP_GUID> | -xC <GUID> <CMD_STRING> | -XC <GUID> <CMD_STRING> | -xE
       <GUID> <0|1> | -XE <GUID> <0|1>

Virtual machine management
 -A,--assign-vm-policy <GUID> <VM_POLICY_GUID>              Assign VM to the policy
 -cS,--create-snapshot <GUID> <RULE_GUID> <PRIORITY>        Create VM snapshot
 -D,--list-disks <GUID>                                     List detected VM disks
 -d,--delete <GUID>                                         Delete VM
 -eD,--exclude-disk <DISK_GUID> <0|1>                       Exclude disk from backup excluded (1) / included (0)
 -dnp,--delete-non-present <[PROJECT_UUID]>                 Delete non-present Virtual Machines. Project UUID is optional
 -g,--details <<VM_GUID>>                                   Show virtual machine details
 -gb,--show-backup-details <BACKUP_GUID>                    Show backup details
 -L,--list-backups <GUID>                                   List backups of the VM
 -l,--list                                                  List VMs
 -rmS,--remove-snapshot <VM_GUID,...,VM_GUID>               Remove old snapshots
 -rvS,--revert-snapshot <SNAPSHOT_GUID>                     Revert snapshot
 -S,--list-snapshots <GUID>                                 List managed VM snapshots
 -sC,--set-ssh-credentials <GUID> <SSH_USER> <SSH_PASS>     Set SSH access credentials
 -se,--set-pre-std-error-out <GUID> <HANDLING>              Set handling for pre-snap standard error. Values: DONT_IGNORE, IGNORE_WITH_WARNING, IGNORE_WITHOUT_WARNING
 -sE,--set-post-std-error-out <GUID> <HANDLING>             Set handling for post-snap standard error. Values: DONT_IGNORE, IGNORE_WITH_WARNING, IGNORE_WITHOUT_WARNING
 -sH,--set-ssh-host <GUID> <SSH_HOST> <SSH_PORT>            Set SSH access host/port
 -si,--set-pre-ignored-codes <GUID> <IGNORED_EXIT_CODES>    Set pre-snap ignored command exit codes e.g. '15, 101-150' or '*'
 -sI,--set-post-ignored-codes <GUID> <IGNORED_EXIT_CODES>   Set post-snap ignored command exit codes e.g. '15, 101-150' or '*'
 -sK,--set-ssh-key-path <GUID> <SSH_KEYPATH>                Set SSH key path
 -T,--list-tasks <GUID>                                     List tasks related to the VM
 -w,--ack-all-backup-warnings <GUID>                        Acknowledge all backup warnings related to the VM
 -wb,--ack-backup-warnings <BACKUP_GUID>                    Acknowledge warnings related to the backup
 -xC,--set-pre-snap-cmd <GUID> <CMD_STRING>                 Set pre-snapshot CMD as semi-colon-separated string, i.e. "cmd;-a;-b"
 -XC,--set-post-snap-cmd <GUID> <CMD_STRING>                Set post-snapshot CMD as semi-colon-separated string, i.e. "cmd;-a;-b"
 -xE,--set-pre-snap-cmd-exec-enabled <GUID> <0|1>           Set pre-snapshot CMD exec enabled (1) / disabled (0)
 -XE,--set-post-snap-cmd-exec-enabled <GUID> <0|1>          Set post-snapshot CMD exec enabled (1) / disabled (0

Examples

  • To list all VMs

    vprotect vm -l
  • To show details of the given VM (by GUID)

    vprotect vm -g 0f36f40c-6427-4035-9f2b-1ead6aca3597
  • To add VM (first GUID) to the given policy (second GUID):

    vprotect vm -A 0f36f40c-6427-4035-9f2b-1ead6aca3597 3afcd507-a4f5-484d-8d34-53c73d7a5809
  • To show backup history of a VM with given GUID:

    vprotect vm -L 0f36f40c-6427-4035-9f2b-1ead6aca3597
  • To create snapshot of a VM with given GUID (VM must have snapshot policy already assigned):

    vprotect vm -cS 0f36f40c-6427-4035-9f2b-1ead6aca3597

Storage backup management

This module is responsible for managing storage instances and actions related to backups/schedules/policies etc.

[root@localhost ~]# vprotect st
Incorrect syntax: Missing required option: 
[-A Assign Storage to the policy, -a Assign Storage to the snapshot policy,
 -d Delete Storage, -g Show Storage details, -wb Acknowledge warnings related
 to the backup, -xC Set pre-snapshot CMD as semi-colon-separated string,
 i.e. "cmd;-a;-b", -XC Set post-snapshot CMD as semi-colon-separated string,
 i.e. "cmd;-a;-b", -l List Storages, -L List backups of the Storage,
 -sC Set SSH access credentials, -se Set handling for pre-snap standard error.
 Values: DONT_IGNORE, IGNORE_WITH_WARNING, IGNORE_WITHOUT_WARNING,
 -sE Set handling for post-snap standard error. Values: DONT_IGNORE,
 IGNORE_WITH_WARNING, IGNORE_WITHOUT_WARNING, -s Modify Storage configuration,
 -T List tasks related to the Storage, -w Acknowledge all backup warnings
 related to the Storage, -gb Show backup details]

usage: st -A <GUID> <STORAGE_POLICY_GUID> | -a <GUID> <SNAPSHOT_POLICY_GUID> |
  -d <GUID> | -g <GUID> | -gb <BACKUP_GUID> | -l | -L <GUID> |
  -s <GUID> <PROPERTY_NO.> <VALUE> | -sC <GUID> <SSH_USER> <SSH_PASS> |
  -se <GUID> <HANDLING> | -sE <GUID> <HANDLING> |-T <GUID> | -w <GUID> |
  -wb <BACKUP_GUID> | -xC <GUID> <CMD_STRING> | -XC <GUID> <CMD_STRING>
Storage management
 -A,--assign-storage-policy <GUID> <STORAGE_POLICY_GUID>
    #Assign Storage to the policy
 -a,--assign-snapshot-policy <GUID> <SNAPSHOT_POLICY_GUID>
    #Assign Storage to the snapshot policy
 -d,--delete <GUID>
    #Delete Storage
 -g,--details <GUID>
    #Show Storage details
 -gb,--show-backup-details <BACKUP_GUID>
    #Show backup details
 -l,--list
    #List Storages
 -L,--list-backups <GUID>
    #List backups of the Storage
 -s,--configuration <GUID> <PROPERTY_NO.> <VALUE>
    #Modify Storage configuration
 -sC,--set-ssh-credentials <GUID> <SSH_USER> <SSH_PASS>
    #Set SSH access credentials
 -se,--set-pre-std-error-out <GUID> <HANDLING>
    #Set handling for pre-snap standard error. Values: DONT_IGNORE,
    #IGNORE_WITH_WARNING, IGNORE_WITHOUT_WARNING
 -sE,--set-post-std-error-out <GUID> <HANDLING>
    #Set handling for post-snap standard error. Values: DONT_IGNORE,
    #IGNORE_WITH_WARNING, IGNORE_WITHOUT_WARNING
 -T,--list-tasks <GUID>
    #List tasks related to the Storage
 -w,--ack-all-backup-warnings <GUID>
    #Acknowledge all backup warnings related to the Storage
 -wb,--ack-backup-warnings <BACKUP_GUID>
    #Acknowledge warnings related to the backup
 -xC,--set-pre-snap-cmd <GUID> <CMD_STRING>
    #Set pre-snapshot CMD as semi-colon-separated string, i.e. "cmd;-a;-b"
 -XC,--set-post-snap-cmd <GUID> <CMD_STRING>
    #Set post-snapshot CMD as semi-colon-separated string, i.e. "cmd;-a;-b"

Examples

Storage pool management

This small module allows us to list and deleting inventoried storage pools.

[root@localhost ~]# vprotect stpool
Incorrect syntax: Missing required option: [-d Delete Storage Pool,
-l List Storage Pools]

usage: stpool -d <GUID> | -l
Storage pool management
 -d,--delete <GUID>        Delete Storage Pool
 -l,--list                 List Storage Pools

Examples

To list storage pools

[root@localhost ~]# vprotect stpool -l

                GUID                   Name                     UUID                   Storage Provider  
------------------------------------  -------  --------------------------------------  ----------------  
b1171aba-aeb3-4e10-84dd-f3e3c0dc3235  backups  537e00c8-620d-4256-8d6c-e5e031327caa_1  last-ceph         
86f41229-6f13-41b3-b1ce-c5841df7b4c7  images   537e00c8-620d-4256-8d6c-e5e031327caa_4  last-ceph         
55832390-1779-483b-8023-88bb9a79b6ed  vms      537e00c8-620d-4256-8d6c-e5e031327caa_3  last-ceph         
ff3a9f65-0b5f-4a78-8b97-b883cb971f81  volumes  537e00c8-620d-4256-8d6c-e5e031327caa_2  last-ceph

Storage providers management

This module is responsible for managing the storage provider's infrastructure. So performing tasks such as adding/removing / inventorying, etc.

[root@localhost ~]# vprotect stprovider
Incorrect syntax: Missing required option: [-sC Modify Storage Provider configuration, -c Create Storage Provider, -s Synchronize inventory with Storage Provider, -d Delete Storage Provider, -u Set user/password, -nC Set node config for Storage Provider, -g Show Storage Providers details, -h Set host for Storage Provider, -l List Storage Providers, -L List Storages for Storage Provider, -n Set node for Storage Provider]

usage: stprovider -c <HOST> <TYPE> | -d <GUID> | -g <GUID> | -h <GUID> <HOST> | -l | -L <GUID> | -n <GUID> <NODE_GUID> | -nC <GUID> <NODE_CONFIG_GUID> | -s <GUID> | -sC <GUID> <PROPERTY_NO.> <VALUE> | -u <GUID> <USER> <PASSWORD>
+Storage provider management
 -c,--create <HOST> <TYPE>                           Create Storage Provider
 -d,--delete <GUID>                                  Delete Storage Provider
 -g,--details <GUID>                                 Show Storage Providers details
 -h,--set-host <GUID> <HOST>                         Set host for Storage Provider
 -l,--list                                           List Storage Providers
 -L,--list-storages <GUID>                           List Storages for Storage Provider
 -n,--set-node <GUID> <NODE_GUID>                    Set node for Storage Provider
 -nC,--set-node-config <GUID> <NODE_CONFIG_GUID>     Set node config for Storage Provider
 -s,--sync <GUID>                                    Synchronize inventory with Storage Provider
 -sC,--configuration <GUID> <PROPERTY_NO.> <VALUE>   Modify Storage Provider configuration
 -u,--credentials <GUID> <USER> <PASSWORD>           Set user/password

Examples

VM backup policies

Virtual machine backup policies management module is used to define backup policies of VMs. You can assign different backup priorities for a policy when the scheduler invokes a backup task. You need first to define a VM policy and then add VMs to it. VM can belong only to a single backup policy.

To manage VM policies in the system use vprotect vmpolicy sub-command.

VMs are assigned automatically to the policy only if VM has no policy assigned already. If an automatic assignment has been turned on for a policy and either name of the VM matches the regular expression, or tag-detected (Citrix/oVirt/RHV/Oracle VM) matches tag defined for the policy, VM is assigned to the policy, and all schedules for a policy will also be automatically invoked for this VM.

Note: it is important to assign a backup destination for a policy (required for a node to know where to store backups)

[root@vprotect ~]# vprotect vmpolicy
Required option: [-rR Remove auto-assignment RE, -rT Remove auto-assignment tag, -aC Set auto-assignment HV clusters, -b Set backup destination for the VM policy, -c Create a new policy, -d Delete a policy, -g Show details, -l List policies, -L List VMs in the policy, -aM Set auto-assignment mode, -m Modify policy, -aN Set auto-removal of non-present VMs flag, -p Set policy's backup task priority (0-100, 50 = default), -aR Add auto-assignment RE, -aT Add auto-assignment tag, -S List schedules for the policy, -s Set schedules for the VM policy, -U Unassign VMs from the policy, -V Assign VMs to the policy]

usage: vmpolicy -aC <GUID > <[HV_CLUSTER_GUID,...,HV_CLUSTER_GUID]> | -aM <GUID> <DISABLED|ASSIGN_ONLY|ASSIGN_AND_REMOVE> | -aN <GUID> <0|1> | -aR <GUID>
       <inc|exc> <REG_EXP> | -aT <GUID> <inc|exc> <TAG> | -b <GUID> <BD_GUID | BD_NAME>> | -c <NAME> | -d <GUID> | -g <GUID> | -l | -L <GUID> | -m <GUID>
       <NAME> | -p <GUID> <PRIORITY> | -rR <GUID> <inc|exc> <REG_EXP> | -rT <GUID> <inc|exc> <TAG> | -S <GUID> | -s <GUID> <SCHED_GUID,...,SCHED_GUID> | -U
       <VM_GUID,...,VM_GUID> | -V <GUID> <VM_GUID,...,VM_GUID>
VM backup policy management
 -aC,--set-auto-assign-hv-clusters <GUID > <[HV_CLUSTER_GUID,...,HV_CLUSTER_GUID]>   Set auto-assignment HV clusters
 -aM,--set-auto-assign-mode <GUID> <DISABLED|ASSIGN_ONLY|ASSIGN_AND_REMOVE>          Set auto-assignment mode
 -aN,--set-auto-remove-non-present <GUID> <0|1>                                      Set auto-removal of non-present VMs flag
 -aR,--add-auto-assign-re <GUID> <inc|exc> <REG_EXP>                                 Add auto-assignment RE
 -aT,--add-auto-assign-tag <GUID> <inc|exc> <TAG>                                    Add auto-assignment tag
 -b,--set-backup-destination <GUID> <BD_GUID | BD_NAME>>                             Set backup destination for the VM policy
 -c,--create <NAME>                                                                  Create a new policy
 -d,--delete <GUID>                                                                  Delete a policy
 -g,--details <GUID>                                                                 Show details
 -l,--list                                                                           List policies
 -L,--list-vms <GUID>                                                                List VMs in the policy
 -m,--modify <GUID> <NAME>                                                           Modify policy
 -p,--set-priority <GUID> <PRIORITY>                                                 Set policy's backup task priority (0-100, 50 = default)
 -rR,--remove-auto-assign-re <GUID> <inc|exc> <REG_EXP>                              Remove auto-assignment RE
 -rT,--remove-auto-assign-tag <GUID> <inc|exc> <TAG>                                 Remove auto-assignment tag
 -S,--list-schedules <GUID>                                                          List schedules for the policy
 -s,--set-schedules <GUID> <SCHED_GUID,...,SCHED_GUID>                               Set schedules for the VM policy
 -U,--unassign-vms <VM_GUID,...,VM_GUID>                                             Unassign VMs from the policy
 -V,--assign-vms <GUID> <VM_GUID,...,VM_GUID>                                        Assign VMs to the policy

Examples

  • To list all VM policies

    vprotect vmpolicy -l
  • To show details of the given VM (by GUID)

    vprotect vmpolicy -g 3afcd507-a4f5-484d-8d34-53c73d7a5809
  • To create a new policy

    vprotect vmpolicy -c "My Policy"
  • To add policy1 tag (include) for a policy:

    vprotect vmpolicy -aT 3afcd507-a4f5-484d-8d34-53c73d7a5809 inc policy1
  • To remove policy1 tag (include) for a policy:

    vprotect vmpolicy -rT 3afcd507-a4f5-484d-8d34-53c73d7a5809 inc policy1
  • To set 2 schedules (GUIDs are comma-separated) for a policy (first GUID):

    vprotect vmpolicy -s 3afcd507-a4f5-484d-8d34-53c73d7a5809 391203e3-ad6c-4532-b69c-78b3a5cf4ef5,e4c1c61d-26db-4e41-87cf-2195d5498cde
  • To set backup destination (you can use name or GUID) for a policy (first GUID):

    vprotect vmpolicy -b 3afcd507-a4f5-484d-8d34-53c73d7a5809 ISP

Snapshot management policies for VMs

The snapshot management policies module enables CDM for your VMs and manages their retention. Currently, it is supported for KVM, Citrix, RHV/oVirt/OLVM platforms.

To manage snapshot policies for VMs in the system use vprotect vm-snappolicy sub-command.

VMs are assigned automatically to the policy only if VM has no policy assigned already. If an automatic assignment has been turned on for a policy and either name of the VM matches a regular expression, or tag-detected (Citrix/RHV/oVirt/OLVM) matches tag defined for the policy, VM is assigned to the policy, and all schedules for a policy will also be automatically invoked for this VM.

Note: only VMs with assigned snapshot management policy can be a snapshot from the CLI or UI

[root@vprotect ~]# vprotect vm-snappolicy
Required option: [-rR Remove rules from policy, -rT Remove auto-assignment tag, -aC Set auto-assignment HV clusters, -c Create a new policy, -d Delete a policy, -g Show details, -l List policies, -L List VMs in the policy, -aM Set auto-assignment mode, -m Modify policy, -aN Set auto-removal of non-present VMs flag, -p Set policy's backup task priority (0-100, 50 = default), -aR Add new rule to selected policy, -r List rules for policy, -aT Add auto-assignment tag, -U Unassign VMs from the policy, -V Assign VMs to the policy]

usage: vm-snappolicy -aC <GUID > <[HV_CLUSTER_GUID,...,HV_CLUSTER_GUID]> | -aM <GUID> <DISABLED|ASSIGN_ONLY|ASSIGN_AND_REMOVE> | -aN <GUID> <0|1> | -aR <NAME>
       <POLICY_GUID> <RETENTION_DAYS> <RETENTION_VERSIONS> | -aT <GUID> <inc|exc> <TAG> | -c <NAME> | -d <GUID> | -g <GUID> | -l | -L <GUID> | -m <GUID>
       <NAME> | -p <GUID> <PRIORITY> | -r <GUID> | -rR <POLICY_GUID> <RULE_GUID,...,RULE_GUID> | -rT <GUID> <inc|exc> <TAG> | -U <VM_GUID,...,VM_GUID> | -V
       <GUID> <VM_GUID,...,VM_GUID>
Snapshot policy management
 -aC,--set-auto-assign-hv-clusters <GUID > <[HV_CLUSTER_GUID,...,HV_CLUSTER_GUID]>   Set auto-assignment HV clusters
 -aM,--set-auto-assign-mode <GUID> <DISABLED|ASSIGN_ONLY|ASSIGN_AND_REMOVE>          Set auto-assignment mode
 -aN,--set-auto-remove-non-present <GUID> <0|1>                                      Set auto-removal of non-present VMs flag
 -aR,--add-rule <NAME> <POLICY_GUID> <RETENTION_DAYS> <RETENTION_VERSIONS>           Add new rule to selected policy
 -aT,--add-auto-assign-tag <GUID> <inc|exc> <TAG>                                    Add auto-assignment tag
 -c,--create <NAME>                                                                  Create a new policy
 -d,--delete <GUID>                                                                  Delete a policy
 -g,--details <GUID>                                                                 Show details
 -l,--list                                                                           List policies
 -L,--list-vms <GUID>                                                                List VMs in the policy
 -m,--modify <GUID> <NAME>                                                           Modify policy
 -p,--set-priority <GUID> <PRIORITY>                                                 Set policy's backup task priority (0-100, 50 = default)
 -r,--list-rules <GUID>                                                              List rules for policy
 -rR,--remove-rules <POLICY_GUID> <RULE_GUID,...,RULE_GUID>                          Remove rules from policy
 -rT,--remove-auto-assign-tag <GUID> <inc|exc> <TAG>                                 Remove auto-assignment tag
 -U,--unassign-vms <VM_GUID,...,VM_GUID>                                             Unassign VMs from the policy
 -V,--assign-vms <GUID> <VM_GUID,...,VM_GUID>                                        Assign VMs to the policy

Examples

  • To list all snapshot policies

    vprotect vm-snappolicy -l
  • To show details of the given VM (by GUID)

    vprotect vm-snappolicy -g 3afcd507-a4f5-484d-8d34-53c73d7a5809
  • To create a new policy

    vprotect vm-snappolicy -c "My Policy"
  • To add policy1 tag (include) for a policy:

    vprotect vm-snappolicy -aT 3afcd507-a4f5-484d-8d34-53c73d7a5809 inc policy1
  • To remove policy1 tag (include) for a policy:

    vprotect vm-snappolicy -rT 3afcd507-a4f5-484d-8d34-53c73d7a5809 inc policy1
  • To set 2 schedules (GUIDs are comma-separated) for a policy (first GUID):

    vprotect vm-snappolicy -s 3afcd507-a4f5-484d-8d34-53c73d7a5809 391203e3-ad6c-4532-b69c-78b3a5c

Snapshot management policies for storage

To manage snapshot policies for storage in the system used vprotect storage-snappolicy sub-command.

Storages are assigned automatically to the policy only if storage has no policy assigned already. If an automatic assignment has been turned on for a policy and the name of the storage matches the regular expression, storage is assigned to the policy, and all schedules for a policy will also be automatically invoked for this storage.

Note: only storage with an assigned snapshot management policy can be a snapshot from the CLI or UI

[root@vprotect ~]# vprotect storage-snappolicy
Incorrect syntax: Missing required option: [-rR Remove rules from policy, -c Create a new policy, -d Delete a policy, -g Show details, -l List policies, -aM Set auto-assignment mode, -L List storages in the policy, -m Modify policy, -aN Set auto-removal of non-present VMs flag, -aP Set auto-assignment storage pools, -p Set policy's backup task priority (0-100, 50 = default), -aR Add new rule to selected policy, -r List rules for policy, -S Assign storages to the policy, -U Unassign storages from the policy]

usage: storage-snappolicy -aM <GUID> <DISABLED|ASSIGN_ONLY|ASSIGN_AND_REMOVE> | -aN <GUID> <0|1> | -aP <GUID > <[STORAGE_POOL_GUID,...,STORAGE_POOL_GUID]> | -aR <NAME> <POLICY_GUID> <RETENTION_DAYS> <RETENTION_VERSIONS> | -c <NAME> | -d <GUID> | -g <GUID> | -l | -L <GUID> | -m
       <GUID> <NAME> | -p <GUID> <PRIORITY> | -r <GUID> | -rR <POLICY_GUID> <RULE_GUID,...,RULE_GUID> | -S <GUID> <STORAGE_GUID,...,STORAGE_GUID> | -U <STORAGE_GUID,...,STORAGE_GUID>
+Snapshot policy management for storages
 -aM,--set-auto-assign-mode <GUID> <DISABLED|ASSIGN_ONLY|ASSIGN_AND_REMOVE>                Set auto-assignment mode
 -aN,--set-auto-remove-non-present <GUID> <0|1>                                            Set auto-removal of non-present VMs flag
 -aP,--set-auto-assign-storage-pools <GUID > <[STORAGE_POOL_GUID,...,STORAGE_POOL_GUID]>   Set auto-assignment storage pools
 -aR,--add-rule <NAME> <POLICY_GUID> <RETENTION_DAYS> <RETENTION_VERSIONS>                 Add new rule to selected policy
 -c,--create <NAME>                                                                        Create a new policy
 -d,--delete <GUID>                                                                        Delete a policy
 -g,--details <GUID>                                                                       Show details
 -l,--list                                                                                 List policies
 -L,--list-storages <GUID>                                                                 List storages in the policy
 -m,--modify <GUID> <NAME>                                                                 Modify policy
 -p,--set-priority <GUID> <PRIORITY>                                                       Set policy's backup task priority (0-100, 50 = default)
 -r,--list-rules <GUID>                                                                    List rules for policy
 -rR,--remove-rules <POLICY_GUID> <RULE_GUID,...,RULE_GUID>                                Remove rules from policy
 -S,--assign-storages <GUID> <STORAGE_GUID,...,STORAGE_GUID>                               Assign storages to the policy
 -U,--unassign-storages <STORAGE_GUID,...,STORAGE_GUID>                                    Unassign storages from the policy

Examples

To list all snapshot policies

  vprotect storage-snappolicy -l
  • To show details of the given snapshot policy (by GUID)

    vprotect storage-snappolicy -g 3afcd507-a4f5-484d-8d34-53c73d7a5809
  • To create a new policy

    vprotect storage-snappolicy -c "My Policy"
  • To set 2 schedules (GUIDs are comma-separated) for a policy (first GUID):

    vprotect vm-snappolicy -s 3afcd507-a4f5-484d-8d34-53c73d7a5809 \
     391203e3-ad6c-4532-b69c-78b3a5c

Schedules

The schedule management module is used to create schedules associated with VMs or groups of VMs. Each schedule defines the days of a week and the hour when the backup tasks should be invoked. Each schedule also defines a time window in which the backup process must start. If the task queue is full and the tasks start after the specified amount of time from the schedule – it will be canceled and marked as failed.

Note:

  • tasks in the queue are run in order from the highest to the lowest priority.

  • you can assign multiple schedules if you need backup to be executed at different hours on different days

  • remember always to assign schedules to VM or VM group – schedule can be assigned only to a single VM or VM group

To manage schedules in the system used vprotect sched sub-command.

[root@vprotect ~]# vprotect sched
Incorrect syntax: Missing required option: [-a Set schedule to be active (1) / not active (0), -c <NAME> <VM_BACKUP | SNAPSHOT | APP_BACKUP> <BACKUP_TYPE> <TIME | INTERVAL> <START_TIME | INTERVAL_START_HOUR-INTERVAL_END_HOUR> <DURATION | INTERVAL_FREQUENCY> <everyday | LIST_OF_DAYS_OF_WEEK> <any | FIRST_IN_MONTH | SECOND_IN_MONTH | THIRD_IN_MONTH | FOURTH_IN_MONTH | LAST_IN_MONTH> <any | LIST_OF_MONTHS 
 Create schedule for VM (backup type: FULL / INCREMENTAL), -d Delete schedule, -g Show details, -l List schedules, -m <GUID> <NAME> <TYPE> <TIME | INTERVAL> <START_TIME | INTERVAL_START_HOUR-INTERVAL_END_HOUR> <DURATION | INTERVAL_FREQUENCY> <everyday | LIST_OF_DAYS_OF_WEEK> <any | FIRST_IN_MONTH | SECOND_IN_MONTH | THIRD_IN_MONTH | FOURTH_IN_MONTH | LAST_IN_MONTH> <any | LIST_OF_MONTHS 
 Modify schedule (backup type: FULL / INCREMENTAL)]

usage: sched -a <arg> | -c <arg> | -d <arg> | -g <arg> | -l | -m <arg>

Schedule management
 -a,--set-active <GUID> <0|1>              Set schedule to be active (1) / not active (0)
 -c,--create     <NAME> <VM_BACKUP | SNAPSHOT | APP_BACKUP> <BACKUP_TYPE> <TIME | INTERVAL> <START_TIME | INTERVAL_START_HOUR-INTERVAL_END_HOUR> <DURATION |
                 INTERVAL_FREQUENCY> <everyday | LIST_OF_DAYS_OF_WEEK> <any | FIRST_IN_MONTH | SECOND_IN_MONTH | THIRD_IN_MONTH | FOURTH_IN_MONTH | LAST_IN_MONTH> <any | LIST_OF_MONTHS>
                                           Create schedule for VM (backup type: FULL / INCREMENTAL)
 -d,--delete <GUID>                        Delete schedule
 -g,--show-details <GUID>                  Show details
 -l,--list                                 List schedules
 -m,--modify <GUID> <NAME> <TYPE> <TIME | INTERVAL> <START_TIME | INTERVAL_START_HOUR-INTERVAL_END_HOUR> <DURATION | INTERVAL_FREQUENCY> <everyday |
               LIST_OF_DAYS_OF_WEEK> <any | FIRST_IN_MONTH | SECOND_IN_MONTH | THIRD_IN_MONTH | FOURTH_IN_MONTH | LAST_IN_MONTH> <any | LIST_OF_MONTHS>
                                           Modify schedule (backup type: FULL / INCREMENTAL)

Examples

  • To list all schedules

    vprotect sched -l
  • To create a full virtual machine backup schedule with a name Schedule1 executed every day at 05:00 with 60 minutes of time window:

    vprotect sched -c Schedule1 VM_BACKUP FULL TIME 05:00 60 everyday any any
  • To create an incremental virtual machine backup schedule with a name Schedule2 executed every Monday, Wednesday and Friday at 17:00 with 90 minutes of time window:

    vprotect sched -c Schedule2 VM_BACKUP INCREMENTAL TIME 17:00 90 mon,wed,fri any any

Note: that days of the week are given as a single comma-separated string of short (3-letter) weekday names

  • To disable a schedule with GUID 6651787d-9a55-421d-8158-ead80a70a9cb:

    vprotect sched -a 6651787d-9a55-421d-8158-ead80a70a9cb 0

VM backup/restore

This module is used to manage the backup and restore processes. It is also used to list backups of a particular VM.

To invoke backup and restore tasks use vprotect brvm sub-command.

[root@vprotect ~]# vprotect brvm
Required option: [-b Backup (full), -B Backup (full) with task priority (0-100, 50 = default), -gL Show file details, -F List file systems, -H Restore the backup to the hypervisor. For KVM mixed volumes please provide storages in form of BF_GUID=STORAGE_ID with files separated by semicolon, i.e. "BF_GUID=STORAGE_ID; BF_GUID2=STORAGE_ID2 ...", -i Backup VM (incremental), -I Backup VM (incremental) with task priority (0-100, 50 = default), -l List backups, -L List backup files, -M Restore the backup to the hypervisor manager, -r Restore the backup, -T List tasks related to the backup, -gb Show backup details]

usage: brvm -b <GUID> <BP_GUID | BP_NAME> | -B <GUID> <BP_GUID | BP_NAME> <PRIORITY> | -F <GUID> | -gb <BACKUP_GUID> | -gL <BACKUP_FILE_GUID> | -H <GUID>
       <HV_GUID | HV_HOST> <STORAGE_ID> | -i <VM_GUID> <BP_GUID | BP_NAME> | -I <VM_GUID> <BP_GUID | BP_NAME> <PRIORITY> | -l | -L <GUID> | -M <GUID>
       <HVM_GUID | HVM_HOST> <STORAGE_ID> <[CLUSTER_ID]> | -r <GUID> <NODE_GUID | NODE_NAME> <DIRECTORY> | -T <GUID>
VM backup & restore
 -b,--backup <GUID> <BP_GUID | BP_NAME>                                         Backup (full)
 -B,--backup-with-priority <GUID> <BP_GUID | BP_NAME> <PRIORITY>                Backup (full) with task priority (0-100, 50 = default)
 -F,--list-file-systems <GUID>                                                  List file systems
 -gb,--show-backup-details <BACKUP_GUID>                                        Show backup details
 -gsi,--show-backup-status-info <BACKUP_GUID>                                   Show backup status info
 -gL,--show-files-details <BACKUP_FILE_GUID>                                    Show file details
 -H,--restore-to-hv <GUID> <HV_GUID | HV_HOST> <STORAGE_ID>                     Restore the backup to the hypervisor. For KVM mixed volumes please provide
                                                                                storages in form of BF_GUID=STORAGE_ID with files separated by semicolon, i.e. "BF_GUID=STORAGE_ID; BF_GUID2=STORAGE_ID2 ..."
 -i,--backup-inc <VM_GUID> <BP_GUID | BP_NAME>                                  Backup VM (incremental)
 -I,--backup-inc-with-priority <VM_GUID> <BP_GUID | BP_NAME> <PRIORITY>         Backup VM (incremental) with task priority (0-100, 50 = default)
 -l,--list                                                                      List backups
 -L,--list-files <GUID>                                                         List backup files
 -M,--restore-to-hvm <GUID> <HVM_GUID | HVM_HOST> <STORAGE_ID> <[CLUSTER_ID]>   Restore the backup to the hypervisor manager
 -r,--restore <GUID> <NODE_GUID | NODE_NAME> <DIRECTORY>                        Restore the backup
 -T,--list-tasks <GUID>                                                         List tasks related to the backup

Examples

  • To list all backups and their status:

    vprotect brvm -l
  • To show backups of a particular VM:

    vprotect vm -L 0f36f40c-6427-4035-9f2b-1ead6aca3597
  • To show files that a specific backup consists of:

    vprotect brvm -L 4f1c7907-72e9-4797-8470-3f1fbb081751
  • To show detected file systems in specific backup:

    vprotect brvm -F 4f1c7907-72e9-4797-8470-3f1fbb081751
  • To create a full backup of a VM and store it in backup destination set to rule called MyTSM

    vprotect brvm -b 0f36f40c-6427-4035-9f2b-1ead6aca3597 MyTSM
  • To restore a full backup with given GUID on the current node (this) to the /vprotect_data

    vprotect brvm -r 2132182d-e9ab-4478-a1db-48222b0e515b this /vprotect_data
  • To create an incremental backup (Citrix only) of a VM and store it in backup destination called MyTSM

    vprotect brvm -i 0f36f40c-6427-4035-9f2b-1ead6aca3597 MyTSM
  • To restore VM backup (first GUID) to the hypervisor (second GUID - Citrix XenServer only) and specific storage

    vprotect brvm -H 2132182d-e9ab-4478-a1db-48222b0e515b c93140b8-a898-4aff-8eef-645587ca8289 "Local storage"

Storage backup/restore

This module is used to manage the backup and restore process of storage providers.

To invoke backup and restore tasks use vprotect brst sub-command.

[root@localhost vprotect]# vprotect brst
Incorrect syntax: Missing required option: [-b Backup (full), -B Backup (full) with task priority (0-100, 50 = default), -r Restore the backup, -S Restore the storage to the storage provider., -T List tasks related to the backup, -gL Show file details, -i Backup STORAGE (incremental), -I Backup STORAGE (incremental) with task priority (0-100, 50 = default), -gb Show backup details, -l List backups, -L List backup files]

usage: brst -b <GUID> <BP_GUID | BP_NAME> | -B <GUID> <BP_GUID | BP_NAME> <PRIORITY> | -gb <BACKUP_GUID> | -gL <BACKUP_FILE_GUID> | -i <STORAGE_GUID> <BP_GUID | BP_NAME> | -I <STORAGE_GUID> <BP_GUID | BP_NAME> <PRIORITY> | -l | -L <GUID> | -r <GUID> <DIRECTORY> | -S <GUID>
       <STORAGE_PROVIDER_GUID | STORAGE_PROVIDER_NAME> <RESTORE_PATH> | -T <GUID>
Storage backup & restore
 -b,--backup <GUID> <BP_GUID | BP_NAME>                                                                   Backup (full)
 -B,--backup-with-priority <GUID> <BP_GUID | BP_NAME> <PRIORITY>                                          Backup (full) with task priority (0-100, 50 = default)
 -gb,--show-backup-details <BACKUP_GUID>                                                                  Show backup details
 -gL,--show-files-details <BACKUP_FILE_GUID>                                                              Show file details
 -i,--backup-inc <STORAGE_GUID> <BP_GUID | BP_NAME>                                                       Backup STORAGE (incremental)
 -I,--backup-inc-with-priority <STORAGE_GUID> <BP_GUID | BP_NAME> <PRIORITY>                              Backup STORAGE (incremental) with task priority (0-100, 50 = default)
 -l,--list                                                                                                List backups
 -L,--list-files <GUID>                                                                                   List backup files
 -r,--restore <GUID> <DIRECTORY>                                                                          Restore the backup
 -S,--restore-to-storage-provider <GUID> <STORAGE_PROVIDER_GUID | STORAGE_PROVIDER_NAME> <RESTORE_PATH>   Restore the storage to the storage provider.
 -T,--list-tasks <GUID>                                                                                   List tasks related to the backup

Examples

  • To list all backups and their status:

    vprotect brst -l
  • To show backups of a particular storage:

    vprotect br -L 0f36f40c-6427-4035-9f2b-1ead6aca3597
  • To show files that a specific backup consists of:

    vprotect brst -L 4f1c7907-72e9-4797-8470-3f1fbb081751
  • To create a full backup of a storage and store it in backup destination called MyTSM

    vprotect brst -b 0f36f40c-6427-4035-9f2b-1ead6aca3597 MyTSM
  • To restore a full backup with given GUID on the current node (this) to the /vprotect_data

    vprotect brst \
    -r 2132182d-e9ab-4478-a1db-48222b0e515b this /vprotect_data
  • To create an incremental backup of a storage and store it in backup destination called MyTSM

    vprotect brst -i 0f36f40c-6427-4035-9f2b-1ead6aca3597 MyTSM

Mounted backups

The Mounted backup management module is used to mount and unmounts backups on the given node. This feature is currently supported for RHV/oVirt/OVM VMs. Each mounted backup can be mounted automatically (auto-detection of mount points within a single root or manually with separate mount points for each volume.

To invoke mount/unmount tasks use vprotect mnt sub-command.

[root@vprotect ~]# vprotect mnt
Incorrect syntax: Missing required option: [-T List tasks related to the mounted backup, -u Unmount previously mounted backup, -F List file systems, -l List mounted backups, -L List mounted files, -mi Mount iSCSI., -m Mount backup according to the MOUNT_SPECIFICATION, -Li List files for selected backup, that can be mounted using iSCSI mode.]

usage: mnt -F <GUID> | -l | -L <GUID> | -Li <BACKUP_GUID> | -m <GUID> <NODE_CONFIG_GUID | NODE_CONFIG_NAME> <auto|manual> <MOUNT_SPECIFICATION> | -mi <BACKUP_GUID> <NODE_CONFIG_GUID | NODE_CONFIG_NAME> <ALLOWED_CLIENT,...,ALLOWED_CLIENT> <DISK_GUID,...,DISK_GUID> | -T <GUID> | -u <GUID>
Mounted backup management
 -F,--list-file-systems <GUID>                                                                                                         List file systems
 -l,--list                                                                                                                             List mounted backups
 -L,--list-files <GUID>                                                                                                                List mounted files
 -Li,--list-iscsi-mountable-files <BACKUP_GUID>                                                                                        List files for selected backup, that can be mounted using iSCSI mode.
 -m,--mount <GUID> <NODE_CONFIG_GUID | NODE_CONFIG_NAME> <auto|manual> <MOUNT_SPECIFICATION>                                           Mount backup according to the MOUNT_SPECIFICATION
 -mi,--mount-iscsi <BACKUP_GUID> <NODE_CONFIG_GUID | NODE_CONFIG_NAME> <ALLOWED_CLIENT,...,ALLOWED_CLIENT> <DISK_GUID,...,DISK_GUID>   Mount iSCSI.
 -T,--list-tasks <GUID>                                                                                                                List tasks related to the mounted backup
 -u,--unmount <GUID>                                                                                                                   Unmount previously mounted backup

Examples

  • To list all mounted backups:

    vprotect mnt -l
  • To list all mounted files used by mounted backup with GUID 1ac068d3-4848-4c98-b30b-54ce050b6a95 (note that this is mounted backup GUID not a backup GUID):

    vprotect mnt -L 1ac068d3-4848-4c98-b30b-54ce050b6a95
  • To show detected file systems in specific backup:

    vprotect mnt -F 1ac068d3-4848-4c98-b30b-54ce050b6a95
  • To mount all file systems in backup with GUID 2132182d-e9ab-4478-a1db-48222b0e515b and node config with GUID 3a9d48dc-e48f-11eb-a1ce-005056a6b7e5 to /mnt/myVM/2017-01-01:

    vprotect mnt -m 2132182d-e9ab-4478-a1db-48222b0e515b 3a9d48dc-e48f-11eb-a1ce-005056a6b7e5 auto /mnt/myVM/2017-01-01
  • To mount manually file systems in backup with GUID 2132182d-e9ab-4478-a1db-48222b0e515b with specifying mount points you need to provide semicolon-separated list where you provide name of the volume=mount point (white space before or after semicolon or equal sign is not allowed)

    vprotect mnt -m 2132182d-e9ab-4478-a1db-48222b0e515b manual "/dev/sda1=/mnt/myVM/sda1;/dev/vg_sda/lv_root=/mnt/myVM/lv_root"
  • To unmount mounted backup with GUID 1ac068d3-4848-4c98-b30b-54ce050b6a95:

    vprotect mnt -u 1ac068d3-4848-4c98-b30b-54ce050b6a95

Tasks

The Task Management module is used to show and cancel tasks being executed. You can also monitor the progress of the tasks.

Note:

  • tasks in the queue are run in order from the highest to the lowest priority.

  • the queue is being periodically cleaned, so only the last tasks are being shown

To manage tasks use vprotect task sub-command.

[root@vprotect ~]# vprotect task
Incorrect syntax: Missing required option: [-Q List queued tasks, -R List running tasks, -d Delete/cancel task, -F List finished (including failed) tasks, -g Show task details, -l List tasks (this node only), -L List tasks (all nodes and not assigned to any node)]

usage: task -d <GUID> | -F | -g <GUID> | -l | -L | -Q | -R
Task management
 -d,--delete <GUID>    Delete/cancel task
 -F,--list-finished    List finished (including failed) tasks
 -g,--details <GUID>   Show task details
 -l,--list             List tasks (this node only)
 -L,--list-all         List tasks (all nodes and not assigned to any node)
 -Q,--list-queued      List queued tasks
 -R,--list-running     List running tasks

Examples

  • To list tasks assigned to the current node:

    vprotect task -l
  • To list all tasks in the system:

    vprotect task -L
  • To show task details:

    vprotect task -g 091d623d-edea-490f-8b3b-da30c09a3f93
  • To cancel the task with ID 091d623d-edea-490f-8b3b-da30c09a3f93:

    vprotect task -d 091d623d-edea-490f-8b3b-da30c09a3f93

Note: some tasks may need to be finished before they are cancelled, for example export VM from the hypervisor – after cancellation it may take some time for the task to process the cancel request and clean up the snapshots etc. If necessary, the backup will be marked as failed.

Project

The Project module is used to view details and set a quota for available projects.

[root@localhost vprotect]# vprotect project
Incorrect syntax: Missing required option: [-g Show Project details, -l List Projects, -sQ Set Project Quota]

usage: project -g <GUID> | -l | -sQ <GUID> <QUOTA_GUID>
Project management
 -g,--details <GUID>                   Show Project details
 -l,--list                             List Projects
 -sQ,--set-quota <GUID> <QUOTA_GUID>   Set Project Quota

Examples

  • To list all projects:

    vprotect project -l
  • To set quota with GUID 6f0bfb3c-24dd-4d12-8a72-997ded2ecc98 to project with GUID ca707d31-f403-40d5-b160-6ac512457b87

    vprotect project -sQ ca707d31-f403-40d5-b160-6ac512457b87 6f0bfb3c-24dd-4d12-8a72-997ded2ecc98

User Management

The User module is used to manage users and their settings. You can add or remove users, change their password or timezone.

[root@localhost vprotect]# vprotect user
Incorrect syntax: Missing required option: [-c Create user, -d Delete user, -g Show user details, -l List users, -m Update user's property, -sP Update user's password, -sA Update user's activation state]

usage: user -c <LOGIN> <FIRST_NAME> <LAST_NAME> <TIMEZONE> <LANGUAGE> <ACTIVE> | -d <GUID> | -g <GUID> | -l | -m <GUID> <PROPERTY_NO.> <VALUE> | -sA <GUID> <ACTIVE> | -sP <GUID>>
User management