The VMware Customer Connect CLI (vcc) allows users to download binaries from customerconnect.vmware.com. It uses the vmware-customer-connect-sdk which was heavily inspired by vmw-sdk by apnex.
WARNING: This CLI is experimental, with no guarantee of future API stability.
vcc is a go binary and can be downloaded from the releases page.
On Linux/Mac the file just needs to be made executable.
To make it available to all users sudo mv vcc-<os>-<version> /usr/local/bin/vcc
The Customer Connect username and password can either be passed in as command arguments using --user and --pass or can be exported as environmental variables, making sure to encase passwords in a single quote in case of special characters.
Example below for Linux/Mac:
export VCC_USER='email@email.com'
export VCC_PASS='##'
The examples below assume that the credentials have been exported as environmental variables.
# Download the latest version of release 11 with a file matching the pattern
vcc download -p vmware_tools -s vmtools -v 11.* -f VMware-Tools-darwin-*.zip --accepteula
# Download files using a manifest file
vcc download -m <filename>.yml --accepteula
# List of available products
vcc get products
# List of available sub-products of product vmware_tools
vcc get subproducts -p vmware_tools
# List of available versions of sub-products vmtools of vmware_tools
vcc get versions -p vmware_tools -s vmtools
# List of available files of version 11.3.0 of vmware_tools
vcc get files -p vmware_tools -s vmtools -v 11.3.0
# Display example manifest file
vcc get manifestexample
Multiple downloads can be specified in a manifest file as below and downloaded using vcc download -m <filename>.yml
---
# This section will download the latest version of vmware_tools
# Each glob pattern will download a single file each
product: vmware_tools
subproduct: vmtools
version: "*"
filename_globs:
- "VMware-Tools-darwin-*.tar.gz"
- "VMware-Tools-darwin-*.zip"
---
# This section will download the latest minor release from major version 10
# The single glob pattern will download 2 files
product: vmware_tools
subproduct: vmtools
version: "10.*"
filename_globs:
- "VMware-Tools-other-*"
---- When working in a shell if you add a * to the filename argument of the download command and you are in a directory where a file matches the pattern, your shell will replace the * to pass in the full file name. This can be worked around by wrapping the file name in single quotes, or by defining the download in a manifest yaml.
- Some products such as horizon will not return the latest version when only a glob is provided. This is because the product switched naming standards meaning it breaks the sort of the version.
- Some product descriptions don't display fully. This is especially true for the horizon products as they are inconsistently named, meaning it's difficult to extract the version number without taking out part of the product name.
Tests assume that you have exported credentials as environmental variables and are run from the root of the repo.
- Run go tests
go test ./... - Run BATS tests with
bats test/bats - To run commands against source use
alias vcc="go run main.go"
Run GOPROXY=direct go get -u ./... to pull in the latest dependencies, including the SDK.
Ensure that your IDE exports VCC_USER and VCC_PASS to be able to run tests and debug.
Please see our Code of Conduct and Contributors guide.
The vmware-customer-connect-cli project team welcomes contributions from the community. Before you start working with vmware-customer-connect-cli, please read and sign our Contributor License Agreement CLA. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will prompt you to do so when you open a Pull Request. For any questions about the CLA process, please refer to our FAQ.
Apache License
