Attix5 Pro FAQ
Search:     Advanced search

Extract account stats from MirrorServer or StorageServer using REST

Article ID: 339
Last updated: 21 Dec, 2015

Requirement

The Storage Platform comes with many reports with all sorts of info, but there is no report on mirror details like disk space used per account. Although it should mirror the data usage on the StorageServer, the problem becomes tricky when you have different retention settings for the MirrorServer, and pretty much impossible when you have a shared MirrorServer hosting data from several Storage Platforms.

Solution

We have now introduced the ability to extract account details from any StorageServer or MirrorServer using REST (from SP v8.15.1130.12101). Just specify the right URL and off you go. Based on the login credentials you supply, the call will return either everything (for the admin account) or a subset of the data (for any mirror accounts). The details will also contain the mirror account which was used to mirror the data (MirrorUser field).

The result can be in CSV, XML, JSON or TXT format depending on how you specify the URL:

https://192.168.1.1:8443/api/storage/accounts.csv 
https://192.168.1.1:8443/api/storage/accounts.xml 
https://192.168.1.1:8443/api/storage/accounts.json
https://192.168.1.1:8443/api/storage/accounts.txt
You can also narrow down the results based on one or several of the fields, e.g.
https://192.168.1.1:8443/api/storage/accounts.txt?MirrorUser=CompanyXYZ
‚Äčhttps://192.168.1.1:8443/api/storage/accounts.txt?AccountName=John.Smith&AccountGroup=Testgroup

Example TXT output

AccountGroup=Testgroup
AccountGuid=0073026f-9dc2-4ae6-9378-156ccf901b53
AccountName=John.Smith
AccountType=Backup
Active=True
BackupCount=23
ClientVersion=8.15.1106.12441
HomeSSId=43160a5b7c8
HSMExportedCount=0
HSMExportedSize=0
LastBackupDate=2015-12-09T00:00:04
Limit=10737418240
MirrorUser=admin
OnDisk=220441606
ProtectedSizeAllBackups=12689789588
ProtectedSizeLastBackup=551729980
SelectedSize=551729152
SourceSSId=43160a4bb7c8

To get the results for a specific mirror account you can either use the specific mirror account credentials to make the call or use the admin credentials and filter on the MirrorUser field.

Article ID: 339
Last updated: 21 Dec, 2015
Revision: 7
Views: 651
Comments: 0
Posted: 09 Dec, 2015 by Marais D.
Updated: 21 Dec, 2015 by Van Rensburg J.
This article was:  
Prev   Next
Article 338 - How to prevent ESE Backup Account sizes from going over limit     Article 340 - Architecting Backup Pro Storage Platforms for Geographical...