Get VMware assets API script

Get VMware assets API go script

Author: santhosh-vrts

recipes/go/assets/README.md

@@ -0,0 +1,23 @@
+### NetBackup API Code Samples in go (golang)
+
+This directory contains code samples for NetBackup Asset Service APIs.
+
+#### Disclaimer
+
+The scripts are provided only for reference and not meant for production use.
+
+#### Pre-requisites:
+
+- NetBackup 8.3 or higher
+- go1.10.2 or higher
+
+#### Executing the script
+
+- get_vmware_assets:
+    `go run ./get_vmware_assets.go -nbserver <NetBackup server> -username <username> -password <password> [-domainName <domainName>] [-domainType <domainType>] [-assetsFilter <filter>]`
+
+The script invokes the NetBackup VMware Asset Service API to get the VMware workload assets (filtered by the given filter if specified). It prints the details (delimited by tab) such as asset display name, instance Id, vCenter and the protection plan names that the asset is protected by.
+_Note: assetsFilter option can be used to filter the assets returned. It should be in OData format (refer to the NetBackup API documentation for more details). It is optional, if not specified the script will print all the VM assets. Redirect the script output to a file to avoid printing the details on terminal._
+
+Examples: `go run ./get_vmware_assets.go -nbserver localhost -username user -password password -domainName domain -domainType NT > vm_assets.txt`
+`go run ./get_vmware_assets.go -nbserver localhost -username user -password password -assetsFilter "contains(commonAssetAttributes/displayName, 'backup')" > vm_assets.txt`

recipes/go/assets/get_vmware_assets.go

@@ -0,0 +1,136 @@
+//This script can be run using NetBackup 8.3 and higher.
+//It gets the list of VMware assets in NetBackup (based on the given filter if specified, else returns all the VMware assets).
+
+package main
+
+import (
+    "flag"
+    "fmt"
+    "log"
+    "os"
+    "strconv"
+    "net/url"
+    "net/http"
+    "io/ioutil"
+    "encoding/json"
+    "utils"
+)
+
+var (
+    nbserver            = flag.String("nbserver", "", "NetBackup Server")
+    username            = flag.String("username", "", "User name for NetBackup API login")
+    password            = flag.String("password", "", "Password for the given user")
+    domainName          = flag.String("domainName", "", "Domain name")
+    domainType          = flag.String("domainType", "", "Domain type")
+    assetsFilter        = flag.String("assetsFilter", "", "Filter string (odata format) to filter the assets")
+)
+
+const usage = "\n\nUsage: go run ./get_vmware_assets.go -nbserver <NetBackup server> -username <username> -password <password> [-domainName <domainName>] [-domainType <domainType>] [-assetsFilter <filter>]\n\n"
+
+func main() {
+    // Print usage
+    flag.Usage = func() {
+        fmt.Fprintf(os.Stderr, usage)
+        os.Exit(1)
+    }
+
+    // Read command line arguments
+    flag.Parse()
+
+    if len(*nbserver) == 0 {
+        log.Fatalf("Please specify the name of the NetBackup Server using the -nbserver option.\n")
+    }
+    if len(*username) == 0 {
+        log.Fatalf("Please specify the username using the -username option.\n")
+    }
+    if len(*password) == 0 {
+        log.Fatalf("Please specify the password using the -password option.\n")
+    }
+
+    httpClient := apihelper.GetHTTPClient()
+    jwt := apihelper.Login(*nbserver, httpClient, *username, *password, *domainName, *domainType)
+
+    vmwareAssetsApiUrl := "https://" + *nbserver + "/netbackup/asset-service/workloads/vmware/assets"
+    defaultSort := "commonAssetAttributes.displayName"
+    assetTypeFilter := "(assetType eq 'vm')"
+
+    req, err := http.NewRequest("GET", vmwareAssetsApiUrl, nil)
+
+    if err != nil {
+        fmt.Printf("Making new HTTP request failed with error: %s\n", err)
+        panic("Script failed.")
+    }
+
+    req.Header.Add("Authorization", jwt)
+    pageLimit := 100
+    offset := 0
+    next := true
+    params := url.Values{}
+
+    if assetsFilter != nil {
+      filter := ""
+      if *assetsFilter != "" {
+        filter = *assetsFilter + " and " + assetTypeFilter
+      } else {
+          filter = assetTypeFilter
+      }
+      params.Add("filter", filter)
+    }
+
+    params.Add("sort", defaultSort)
+    params.Add("page[offset]", strconv.Itoa(offset))
+    params.Add("page[limit]", strconv.Itoa(pageLimit))
+
+    fmt.Println("\nGetting VMware assets...")
+    fmt.Println("Printing the following asset details: Display Name, VM InstanceId, vCenter, Protection Plan Names\n")
+
+    for next {
+      req.URL.RawQuery = params.Encode()
+      resp, err := httpClient.Do(req)
+
+      if err != nil {
+          fmt.Printf("Get VMware Assets failed with error: %s\n", err)
+          panic("Script failed.")
+      } else {
+          respJson, _ := ioutil.ReadAll(resp.Body)
+          if resp.StatusCode == 200 {
+            var respPayload interface{}
+            json.Unmarshal(respJson, &respPayload)
+            respData := respPayload.(map[string]interface{})
+            assetsData := respData["data"].([]interface{})
+            printAssetDetails(assetsData)
+            next = respData["meta"].(map[string]interface{})["pagination"].
+                (map[string]interface{})["hasNext"].(bool)
+          } else {
+            fmt.Println(string(respJson))
+            next = false
+          }
+      }
+      offset, _ = strconv.Atoi(params["page[offset]"][0])
+      params["page[offset]"][0] = strconv.Itoa(offset + pageLimit)
+    }
+
+    fmt.Println("\nScript completed.\n")
+}
+
+func printAssetDetails(assets []interface{}) {
+  for _, asset := range assets {
+    assetAttrs := asset.(map[string]interface{})["attributes"].(map[string]interface{})
+    assetCommonAttrs := assetAttrs["commonAssetAttributes"].(map[string]interface{})
+    displayName := assetCommonAttrs["displayName"]
+    instanceId := assetAttrs["instanceUuid"]
+    vCenter := assetAttrs["vCenter"]
+
+    var protectionPlans []string
+    if activeProtections, protected := assetCommonAttrs["activeProtection"]; protected {
+      protectionDetailsList := activeProtections.(map[string]interface{})["protectionDetailsList"].([]interface{})
+
+      for _, protectionDetails := range protectionDetailsList {
+        protectionPlans = append(protectionPlans, protectionDetails.
+                (map[string]interface{})["protectionPlanName"].(string))
+      }
+    }
+    fmt.Printf("%s\t%s\t%s\t%v\n", displayName, instanceId, vCenter, protectionPlans)
+  }
+
+}