Export settings from vRops

Have you ever wanted to export settings from vRops, either as a form of backup or to migrate to another installation? Then you know how cumbersome it can be to find all the settings and export them one by one and also remembering to get it all. To help me get this task done I have created this Powershell script which uses the vRops API to export the settings to xml files which can be easily be imported if or when needed.

The list of settings being exported:

  • ActionDefinitions
  • AlertDefinitions
  • AlertPlugins
  • Authentication Sources
  • Email Templates
  • GlobalSettings
  • Groups, their role and members
  • Licenskeys
  • Maintenanceschedules
  • Notifications Rules
  • Recommendations
  • ReportDefinitions
  • Roles and their privilege
  • Solutions
  • SolutionsAdapters
  • SolutionsCredentials (no password included)
  • Supermetrics
  • SymptomDefinitions
  • Users, their groups and role



There are a few variables which needs to be changed for you to export settings from vRops. Username and password of a user which has API access. This could be the admin user, but better yet you have an account with read-only API access. Also the FQDN or IP of your vRops master node needs to be changed. lastly, per default the script will export data to C:\temp, if you have another location change this variable as well.

I have as usual put the script up on github as a gist for everybody to consume.


Final word

These exports can be used to import settings into vRops. They are hardly readable by humans, but that is also the point with these exports. They are meant to be machine readable, hence they are hard to read for humans. If needed, the same constructs as used in this script can be used to make exports which is readable by humans and manipulated in applications such as Excel. This is out of the scoop of this blog post, but it is a feature I use my self quite often.

12 thoughts on “Export settings from vRops

  1. Really Nice work on this export script 🙂

    How do we make the import work when it often requires a JSON format?
    Supermetrics failed for example.


    1. Hi Rodders

      Right now it is a manual task. Please do note that super metric gets exported as xml and not json which is requried. I havn’t come around a fixed that.

  2. Good work, I’ve been looking for something like this. VROPs is so huge for our environment that it’s not exactly easy to backup. Have you tested this with 6.7 and 7.0?

    1. I build it for 6.5 and have not tested it on 6.7 or 7.0. I think I need to revisit the solution once more, for export and import 🙂

      I can think of a reason why it should not be working for 6.7 or 7.0.

  3. Thank you for the script. How do you import the settings back to another instance? say you want to import the roles to another instance. Would you be able to show an example? Thank you.

  4. Getting below error while running the script.

    Invoke-Webrequest: The remote server returned an error: (401) unauthorized

    1. you need to authenticate with a user that has API privileges, fx the admin or you need to grant a user that permission in vRops.

Leave a Reply

Your email address will not be published. Required fields are marked *