OVHcloud CLI
ovhcloud is a single, unified command-line interface for managing the full range of OVHcloud products and account resources directly from your terminal.
Latest releasev0.15.0GitHub
# Install with the script$ curl -fsSL https://raw.githubusercontent.com/ovh/ovhcloud-cli/main/install.sh | sh # Log in and save credentials$ ovhcloud login # List VPS instances (tabular)$ ovhcloud vps list # List instances and filter on GRA9 region$ ovhcloud cloud instance list --filter 'region=="GRA9"'
Install
Installation command
$ curl -fsSL https://raw.githubusercontent.com/ovh/ovhcloud-cli/main/install.sh | shHomebrew
$ brew install --cask ovh/tap/ovhcloud-cliDocker
$ docker run -it --rm -v ovhcloud-cli-config-files:/config ovhcom/ovhcloud-cli loginFrom the source (requires Go)
$ go install github.com/ovh/ovhcloud-cli/cmd/ovhcloud@latestOr download the latest release, untar or unzip the archive, and add its folder to your PATH.
Log in
Log in and create API credentials, interactively:
$ ovhcloud loginOr set them in ~/.ovh.conf:
[default] endpoint = ovh-eu [ovh-eu] client_id = <OAuth 2.0 client ID> client_secret = <OAuth 2.0 client secret> [ovh-cli] default_cloud_project = <public cloud project ID>
Or in the environment:
OVH_ENDPOINT=ovh-eu OVH_APPLICATION_KEY=xxx OVH_APPLICATION_SECRET=xxx OVH_CONSUMER_KEY=xxx OVH_CLOUD_PROJECT_SERVICE=<public cloud project ID>
Profiles, custom headers and every other means: the CLI's authentication page.
Examples
| Task | Command |
|---|---|
| Log in and save credentials | ovhcloud login |
| List VPS instances (tabular) | ovhcloud vps list |
| Fetch details of a single VPS in JSON | ovhcloud vps get <service_id> -o json |
| Reinstall a baremetal interactively | ovhcloud baremetal reinstall <id> --editor |
| List instances and filter on GRA9 region | ovhcloud cloud instance list --filter 'region=="GRA9"' |
Commands
ovhcloud [command] {subcommands} {parameters/flags}- account
- Manage your account
- alldom
- Retrieve information and manage your AllDom services
- baremetal
- Retrieve information and manage your Bare Metal services
- browser
- Launch a TUI for the OVHcloud Manager - Public Cloud universe only [EXPERIMENTAL]
- cdn-dedicated
- Retrieve information and manage your dedicated CDN services
- cloud
- Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
- completion
- Generate the autocompletion script for the specified shell
- config
- Manage your CLI configuration
- dedicated-ceph
- Retrieve information and manage your Dedicated Ceph services
- dedicated-cloud
- Retrieve information and manage your DedicatedCloud services
- dedicated-cluster
- Retrieve information and manage your DedicatedCluster services
- dedicated-nasha
- Retrieve information and manage your Dedicated NasHA services
- domain-name
- Retrieve information and manage your domain names
- domain-zone
- Retrieve information and manage your domain zones
- email-domain
- Retrieve information and manage your Email Domain services
- email-mxplan
- Retrieve information and manage your Email MXPlan services
- email-pro
- Retrieve information and manage your EmailPro services
- help
- Help about any command
- hosting-private-database
- Retrieve information and manage your HostingPrivateDatabase services
- iam
- Manage IAM resources, permissions and policies
- ip
- Retrieve information and manage your IP services
- iploadbalancing
- Retrieve information and manage your IP LoadBalancing services
- ldp
- Retrieve information and manage your LDP (Logs Data Platform) services
- location
- Retrieve information and manage your Location services
- login
- Login to your OVHcloud account to create API credentials
- nutanix
- Retrieve information and manage your Nutanix services
- okms
- Retrieve information and manage your OKMS services
- overthebox
- Retrieve information and manage your OverTheBox services
- ovhcloudconnect
- Retrieve information and manage your OVHcloud Connect services
- pack-xdsl
- Retrieve information and manage your PackXDSL services
- sms
- Retrieve information and manage your SMS services
- ssl
- Retrieve information and manage your SSL services
- ssl-gateway
- Retrieve information and manage your SSL Gateway services
- storage-netapp
- Retrieve information and manage your Storage NetApp services
- support-tickets
- Retrieve information and manage your support tickets
- telephony
- Retrieve information and manage your Telephony services
- veeamcloudconnect
- Retrieve information and manage your VeeamCloudConnect services
- veeamenterprise
- Retrieve information and manage your VeeamEnterprise services
- version
- Get OVHcloud CLI version
- vmwareclouddirector-backup
- Retrieve information and manage your VMware Cloud Director Backup services
- vmwareclouddirector-organization
- Retrieve information and manage your VMware Cloud Director Organizations
- vps
- Retrieve information and manage your VPS services
- vrack
- Retrieve information and manage your vRack services
- vrackservices
- Retrieve information and manage your vRackServices services
- webhosting
- Retrieve information and manage your WebHosting services
- xdsl
- Retrieve information and manage your XDSL services
Global options
- -d, --debug
- Activate debug mode (will log all HTTP requests details)
- -h, --help
- help for ovhcloud
- -e, --ignore-errors
- Ignore errors in API calls when it is not fatal to the execution
- -o, --output
- Output in JSON, YAML, interactive or custom format (expression using gval format)