Skip to main content

vcli - a universal Veeam CLI tool


Forum|alt.badge.img+3
  • Comes here often
  • 19 comments

Hi all, 

I’ve been toying around with the idea of a cli tool that works with everything and is related to the other post I put up today on the Go-Veeam-Auth that does authentication for all Veeam APIs. 

Anyway, I’ve come up with vcli a simple terminal app written in Go, allowing you to switch between APIs with minimal effort quickly. All the authentication is set up, so all you need to do is set some environmental variables, and off you go (no pun intended).

The main output is JSON, but you can switch it over to YAML via a --yaml switch.

The tool only does GET requests at the moment, as I wanted to gauge the interest before committing any more time to the project. 

Where the power really comes in when it is coupled with “nushell” which is a data-centric approach to shells. It makes manipulating json response objects a breeze and also allows conversion to other data formats. It also has a whole module system which I go into a bit on my GitHub. 

GitHub page: https://github.com/shapedthought/vcli 

NuShell: https://www.nushell.sh/

YouTube video: 

 

The app is compiled in the releases via GitHub actions which you can double-check before downloading the binary, or you can clone the repo and compile it locally.

If you don’t like the idea of downloading or compiling the app I also have a section on GitHub about compiling the tool in a Docker container.

Any issues please raise them on the GitHub page; also, if anyone wants to contribute, feel free to send a pull request.

Note this provided under the MIT license.

Edx

10 comments

JMeixner
Forum|alt.badge.img+17
  • On the path to Greatness
  • 2651 comments
  • February 2, 2023

Nice, I am missing a real CLI for Veeam for a long time now. 😎👍🏼


Chris.Childerhose
Forum|alt.badge.img+21
  • Veeam Legend, Veeam Vanguard
  • 8564 comments
  • February 2, 2023

Very cool to have a Veeam CLI for sure. 👍


Forum|alt.badge.img+1
  • Comes here often
  • 11 comments
  • February 3, 2023

Very nice!

I was looking for the “why?” when comparing it to Powershell, but you explained that on your github page i see. Makes sense.


Iams3le
Forum|alt.badge.img+11
  • Veeam Legend
  • 1396 comments
  • February 3, 2023

Awesome!


vAdmin
Forum|alt.badge.img+2
  • Influencer
  • 173 comments
  • February 6, 2023

Wow, this is so cool. 


Forum|alt.badge.img+3
  • Author
  • Comes here often
  • 19 comments
  • February 6, 2023

v0.3.0 is out; it now supports the Enterprise Manager API.

Remember to give it a star on GitHub if you like this project!

 


Forum|alt.badge.img+3
  • Author
  • Comes here often
  • 19 comments
  • February 7, 2023

I’m working POST now; the tools will support JSON and YAML data formats. 

Here’s an example of starting a job:

 


coolsport00
Forum|alt.badge.img+20
  • Veeam Legend
  • 4181 comments
  • February 28, 2023

This is really cool @EdxH ! Nice job!


vergoted
Forum|alt.badge.img+1
  • Comes here often
  • 24 comments
  • March 3, 2023

Nice one. 


k00laidIT
Forum|alt.badge.img+8
  • Veeam Vanguard
  • 73 comments
  • March 25, 2024
EdxH wrote:

Hi all, 

I’ve been toying around with the idea of a cli tool that works with everything and is related to the other post I put up today on the Go-Veeam-Auth that does authentication for all Veeam APIs. 

Anyway, I’ve come up with vcli a simple terminal app written in Go, allowing you to switch between APIs with minimal effort quickly. All the authentication is set up, so all you need to do is set some environmental variables, and off you go (no pun intended).

The main output is JSON, but you can switch it over to YAML via a --yaml switch.

The tool only does GET requests at the moment, as I wanted to gauge the interest before committing any more time to the project. 

Where the power really comes in when it is coupled with “nushell” which is a data-centric approach to shells. It makes manipulating json response objects a breeze and also allows conversion to other data formats. It also has a whole module system which I go into a bit on my GitHub. 

GitHub page: https://github.com/shapedthought/vcli 

NuShell: https://www.nushell.sh/

YouTube video: 

 

The app is compiled in the releases via GitHub actions which you can double-check before downloading the binary, or you can clone the repo and compile it locally.

If you don’t like the idea of downloading or compiling the app I also have a section on GitHub about compiling the tool in a Docker container.

Any issues please raise them on the GitHub page; also, if anyone wants to contribute, feel free to send a pull request.

Note this provided under the MIT license.

Edx

Nice idea! I’ve been toying with a community powershell module for years but this is a nice evolution of that. https://github.com/k00laidIT/VeeamCommunity


Comment