Skip to main content
  • Place orders quickly and easily
  • View orders and track your shipping status
  • Enjoy members-only rewards and discounts
  • Create and access a list of your products

Avamar: GoAV Tool

Summary: GoAV is a tool written for Avamar in the programming language, "Go." GoAV is a command-line interface (CLI) tool used on Avamar to gather information and troubleshoot the Avamar environment. ...

This article applies to This article does not apply to This article is not tied to any specific product. Not all product versions are identified in this article.

Instructions


Overview
GoAV is a command-line interface (CLI) tool written in the "Go" programming language. The name "GoAV" comes from the combination of "Go" and "Avamar." New features are added to GoAV periodically.
 

Downloading the latest GoAV Tool

1. Click on the following GoAV Central Solution link to download the tool and documentation:
goav download zip page
2. From this page, download goav.zip.

3. Click the "Associated Files" tab:
 
goav associated files download page

4. From this page, download the associated GoAV Documentation.

 
Installing the GoAV Tool

1. Upload goav.zip to the Avamar Utility Node

2. Extract the .zip file:
 
unzip -o goav.zip

3. Make the GoAV binary executable:
 
chmod a+x goav

4. Check the version installed:
 
./goav version show
===========================================================
GoAv    :        1.63
Avamar  :        19.10
Date    :        16 Feb 2024 12:44 EST
===========================================================
COMMAND :  ./goav version show
NOTE: This is not an official tool
===========================================================
GoAV : 1.63

 

Update the existing Goav Version:

The update feature checks the current version of GoAV on the repository site and attempts to pull the latest version:
 
./goav update

 

Command Structure


GoAV has the root command, "goav" and subcommands paired with their own set of flags.

Command line tool for Avamar.

Usage:
  goav [command]

Available Commands:
  activity      Activity related operations.
  client        Client related operations.
  dataset       Dataset related operations.
  dd            DataDomain related operation
  documentation Generate GOAV PDF documentation.
  envinfo       Environment Information.
  help          Help about any command
  idpa          Allows a user to check or fix multiple internal client/policy issues
  ndmp          NDMP related operations
  plugin        Avamar plugin related operation.
  policy        Policy related operations.
  proxy         Avamar VMImage proxy related operations.
  rabbitmq      RabbitMQ related operations.
  replication   Replication related operations.
  retention     Retention related operations.
  rule          Rules related operations.
  schedule      Schedule related operations.
  security      certificate, keystore, secure operations
  system        Avamar system related operations.
  update        Update GOAV to latest version.
  vcenter       vCenter related operations.
  version       Displays the GoAV version information.
  vm            Virtual Machine related operations.

Flags:
  -d, --debug      debug output
  -f, --force      Ignore Configuration
  -h, --help       help for goav
  -n, --noheader   Do not display header

Use "goav [command] --help" for more information about a command.

 

Get Command Help.

Get help for any command by using the global flag, "-h" :
 
./goav client show-gsan -h
Show Avamar clients in gsan, as opposed to mcdb
Gsan is where backups are actually stored, it is useful to get a list from gsan instead of mcdb sometimes!

Usage:
  goav client show-gsan [flags]

Aliases:
  show-gsan, list-gsan

Examples:
./goav client show-gsan
./goav client show-gsan --domain /REPLICATE
./goav client show-gsan --hasBackups
./goav client show-gsan --noBackups --domain /MC_RETIRED --hasbackups

Flags:
      --domain string   Specify domain root to start recursive search from (default "/")
      --hasBackups      List clients with backups in gsan, excluding clients without backups
  -h, --help            help for show-gsan
      --noBackups       List clients with no backups in gsan, excluding clients with backups
      --out string      Specify output filename for report (default "/home/admin/goav_clients/client_list_report_2023-07-10-1689007451.csv")

Global Flags:
  -d, --debug      debug output
  -f, --force      Ignore Configuration
  -n, --noheader   Do no display header

 

Example Usage

Show all proxies connected to Avamar:
 
./goav proxy show
===========================================================
GoAv    :        1.51
Avamar  :        19.8
Date    :        10 Jul 2023 12:48 EDT
===========================================================
COMMAND :  ./goav proxy show
NOTE: This is not an official tool
===========================================================
              name                 | domainFqdn |            vcenterHost            |                    id                    | activated | autoDsMapping | clientVersion
-------------------------------+------------+-----------------------------------+------------------------------------------+-----------+---------------+----------------
  abc-proxy-95.example.company.com | /clients   | xyz-test1-vcenter.lab.company.com | e90b74a9c0c4569d1a0b84fd6ff4f3026939bd12 | true      | false         | 19.8.100-83
  abc-proxy-96.example.company.com | /clients   | xyz-test1-vcenter.lab.company.com | 214d56edb74df890bd88f0c06360216b423ce5fd | true      | false         | 19.8.100-83
 
References:

The following knowledge articles provide additional information about specific GoAV features:

Additional Information

For additional details watch this video:

Affected Products

Avamar
Article Properties
Article Number: 000192151
Article Type: How To
Last Modified: 05 Sep 2024
Version:  17
Find answers to your questions from other Dell users
Support Services
Check if your device is covered by Support Services.