NMC Report using the CLI - gstclreport

NetWorker Commands App:
Google Play Store - https://qrgo.page.link/nBvSt
Apple App store - https://apps.apple.com/us/app/networker-commands/id1553582875#?platform=iphone
=========================================================================
My Lab Set up:
AMD Ryzen 7 3700x processor - https://amzn.to/32SHIXX
GIGABYTE X570 AORUS ELITE Wifi - https://amzn.to/31VDJuE
RIPJAW 16GB - https://amzn.to/34Y5UuJ
Radeon RX 580 - https://amzn.to/32P3j3w
cooler master 550 watt power supply - https://amzn.to/3lMSUy8
=========================================================================
Contact Information:
Twitter - https://twitter.com/CrazyrovS
Website - https://crazyrov.com/
Email - [email protected]
DELL EMC Community Page - https://www.dell.com/community/user/viewprofilepage/user-id/3566590
=========================================================================
Every application needs reporting functionality and a backup application definitely needs one and in NetWorker this reporting tool is part of the [next slide] Networker management console. Make sure that the option for data gathering is enabled when you add the NetWorker server to the NMC.

However the NMC report functionality has a very common error. This error has plagued me for a long time during my operation duty days and I was never able to get to the root of this error and did not try that hard either because I found a workaround.

Enter - gstclreport, the CLI command to generate the same kind of report that the NMC reports could. Now using this is not that straight forward at first but once you are familiar with how to build it it becomes easy. Another best use case that I could find for using the CLI instead of the GUI is the ability to automate the report generation process.

gstclreport
– r reportname
–u username [ –P password ]
[ – a chartselector ]
[ – c charttype ]
[ – f filename ]
[ –n fontfamily ]
[ – o orientation ]
[ – v viewtype ]
[ – x exporttype ]
[ –C parameter_name parameter_value ]


Lets take a look at the available switches:
where:
-h Print this help message
-r reportname The full path of the report to run like "/Reports/Users/User List"
-u username Log into GST server with given name
-P password Log into GST server with given password
-a chartselector The set of Y axis to display in a chart
-c chartype The chart type [bar | pie | plot | "stacking bar"]
-f filename The name of the export file
-n fontfamily A font family to override the default
-o orientation The orientation [portrait | landscape]
-v viewtype The view type [table | chart]
-x exporttype The type of export [ pdf | postscript | html
| csv | print]
-C "Backup Type" argument Where argument is a comma-separated
list of Backup Types
-C Level argument Where argument is a comma-separated
list of Levels
-C "Save Time" argument Where argument is a From and To date
-C "Server Name" argument Where argument is a comma-separated
list of Server Names


The path where this command resides is not added to the PATH env variable so you might have to either add it to the path or run it using the complete path which is /opt/lgotnmc/bin and the command gstclreport.

There is a prerequisite since the gstclreport is java based so we will need the environment variable JAVA_HOME set to the path of the JRE Location

Example:
gstclreport -u username -P password \
-r "/Reports/NetWorker Backup Statistics/Client Summary" \
-C "Group Name" "Default, Nightly, Marketing, Building A, Building B" \
-C "Save Time" "01/01/2003 01:00 AM"


gstclreport -u username -P password
-r "/Reports/NetWorker Backup Statistics/Group Summary/Daily
Group Report"
-v chart -c pie -x html -f "DailyGroups" -C "Save Time" "1 day"
Generated Report "/Reports/NetWorker Backup Statistics/Group