Horizon Cloud Service CLI
Project description
horizon-cloud-service-cli
Overview
Command line toolbox for VMware Horizon Cloud Service (HCS) Next-Gen. It provides human-friendly operations based on HCS REST API.
Try it out
Prerequisites
- Python 3.10+
- Pip3
Refer to Setup Prerequisites for more details.
Installation
Mac & Linux
Install the tool
pip3 install hcs-cli
Windows
Install the tool.
pip install hcs-cli
If you have python installed with option "Add python to path", it should be fine. Otherwise, you need to add python and it's Script directory to path.
Use the CLI
Use with default public HCS service.
hcs login
Run a command, for example, list templates:
hcs admin template list
Authentication Methods
For the first time with each profile, it needs authentication. There are three ways to authenticate:
Example | Purpose |
---|---|
hcs login [--org <org-id>] | Login with configured credentials, otherwise do an interactive login using browser. Note that if your CSP default org is not the target org for HCS, the --org argument must be specified for initial login. |
hcs login --api-token <csp-api-token> | Login with CSP API token. Reference: Get CSP User API Token. |
hcs login --client-id <client-id> --client-secret <client-secret> [--org <org-id>] | Login with OAuth client id/secret. |
To get the current authentication information:
hcs login -d
Security Practice
HCS CLI stores authentication information in a conventional way. The profile and authentication state after login are stored in the current user home directory. The best practice is to use it on a single user system with admin privilege.
Documentation
- Work with development environments
- HCS CLI Cheatsheet
- HCS Plan, a resource manager for deployment
- Development Setup
- Context Programming
Contributing
The horizon-cloud-service-cli project team welcomes contributions from the community. Before you start working with horizon-cloud-service-cli, please read and sign our Contributor License Agreement CLA. If you wish to contribute code and you have not signed our 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.
License
Apache 2.0
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hcs_cli-0.1.102-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5508bc7af5b369b7edb2de43470bb431a9b5986e6d93f17cd30990ce2c654ec |
|
MD5 | 7d78e271fe8646894c1115475b0d6874 |
|
BLAKE2b-256 | 7b51b1c5efe9f0c67e52140fbd5852c9a3dffa4e03b15a6a62fe7f341887391c |