Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

veeam: update API commands and versions in doc #357

Merged
merged 6 commits into from
Feb 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions source/adminguide/backup_and_recovery.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Supported APIs:

- **listBackupProviders**: lists available backup provider plugins
- **listBackupProviderOfferings**: lists external backup policy/offering from a provider
- **importBackupProviderOfferings**: allows importing of an external backup policy/offering to CloudStack as a backup offering
- **importBackupOffering**: allows importing of an external backup policy/offering to CloudStack as a backup offering
- **listBackupOfferings**: lists CloudStack's backup offerings (searching via keyword, and pagination supported)
- **deleteBackupOffering**: deletes a backup offering by its ID

Expand Down Expand Up @@ -168,10 +168,10 @@ Supported APIs:
- **listBackupSchedule**: returns backup schedule of an Instance if defined.
- **deleteBackupSchedule**: deletes backup schedule of an Instance.
- **createBackup**: creates an adhoc backup for an Instance.
- **deleteVMBackup**: deletes an Instance backup (not support for per restore point for Veeam).
- **deleteBackup**: deletes an Instance backup (not support for per restore point for Veeam).
- **listBackups**: lists backups.
- **restoreBackup**: restore a previous Instance backup in-place of a stopped or destroyed Instance.
- **restoreVolumeFromBackup**: restore and attach a backed-up volume (of an Instance backup) to a specified Instance.
- **restoreVolumeFromBackupAndAttachToVM**: restore and attach a backed-up volume (of an Instance backup) to a specified Instance.


.. |B&R-assignOffering.png| image:: /_static/images/B&R-assignOffering.png
Expand Down
25 changes: 14 additions & 11 deletions source/adminguide/veeam_plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ There are a couple of important concepts to understand before working with the V
Installing Veeam Backup and Recovery for use with CloudStack
-------------------------------------------------------------

The B&R Veeam plugin has been tested against Veeam Backup and Recovery 9.5 update 4b (Enterprise version). The
The B&R Veeam plugin has been tested against Veeam Backup and Recovery 11 and 12. The
enterprise edition is required for the Enterprise Manager API. The final tested version of Veeam was on a
Windows Server 2019 (with desktop), although much of the development work was done against a Windows Server 2016 OS (with
desktop).
Expand All @@ -58,7 +58,7 @@ and Replication, however please read the steps below carefully to ensure that yo
compatibility with the B&R Veeam plug-in.


#. Install Backup and Replication 9.5 Manager - inc console - default settings
#. Install Backup and Replication Manager - inc console - default settings
#. Install Enterprise manager
#. Install an SSH server on the 'Veeam Backup and Replication Manager' server. Windows Server 2019 has 'OpenSSH Server' as a
builtin optional feature which is compatible.
Expand Down Expand Up @@ -126,15 +126,18 @@ Plug-in specific settings:

.. cssclass:: table-striped table-bordered table-hover

==================================== ========================
Configuration Description
==================================== ========================
backup.plugin.veeam.url Veeam B&R server URL. Default: http://<VEEAM_SERVER_IP>:9398/api/
backup.plugin.veeam.username Veeam B&R server username. Default: administrator
backup.plugin.veeam.password Veeam B&R server password. Default:
backup.plugin.veeam.validate.ssl Whether to validate Veeam B&R server (SSL/TLS) connection while making API requests. Default: false
backup.plugin.veeam.request.timeout Veeam B&R API request timeout in seconds. Default: 300
==================================== ========================
======================================= ========================
Configuration Description
======================================= ========================
backup.plugin.veeam.url Veeam B&R server URL. Default: http://<VEEAM_SERVER_IP>:9398/api/
backup.plugin.veeam.version Veeam B&R server version. CloudStack will get Veeam server version via PowerShell commands if it is 0 or not set
backup.plugin.veeam.username Veeam B&R server username. Default: administrator
backup.plugin.veeam.password Veeam B&R server password. Default:
backup.plugin.veeam.validate.ssl Whether to validate Veeam B&R server (SSL/TLS) connection while making API requests. Default: false
backup.plugin.veeam.request.timeout Veeam B&R API request timeout in seconds. Default: 300
backup.plugin.veeam.task.poll.interval The time interval in seconds when the management server polls for Veeam task status. Default: 5
backup.plugin.veeam.task.poll.max.retry The max number of retrying times when the management server polls for Veeam task status. Default: 120
======================================= ========================


.. |BnR-DummyTagCategory.jpg| image:: /_static/images/BnR-DummyTagCategory.jpg
Expand Down