OVHcloud CLI
OVHcloud CLI
The official CLI for managing all your OVHcloud cloud services from your terminal. It offers quick installation and simple sign-in, and allows you to easily manage your OVHcloud services.
Installation
In one command
Uses
Testing, development, and production
Agentic-ready
Compatible with your CI/CD pipelines
Coverage
For most OVHcloud services and infrastructures
Benefits
Boost your speed, automate workflows, and maintain control over your OVHcloud services with a solution tailored for DevOps and SRE teams.
Speed and efficiency
A single command to list, create, edit, or delete resources. Spend less time on graphical interfaces by working directly from your terminal.
CI/CD and automation
Integrate the CLI into your scripts, pipelines, and orchestration tools. This is ideal for large-scale deployment and migration, as it allows you to easily replicate your workflows.
Control and transparency
Open-source code, clear commands, and outputs that can be structured into JSON, YAML, or table formats. Designed for development and DevOps teams focused on maintaining control.
OVHcloud specifications
A CLI built to meet market standards and fit within the OVHcloud ecosystem.
Scalability alongside OVHcloud services
The CLI’s roadmap is designed to support a broad range of OVHcloud services. It provides a single tool for managing OVHcloud services: Public Cloud, Private Cloud, Bare Metal, VPS, hosting, networking, databases, AI.
Full compatibility with the OpenStack platform
The OVHcloud CLI enhances the technologies provided by some of our services (e.g., kubectl, S3). It offers complete reversibility and tools tailored to your specific requirements.
A CLI for the entire OVHcloud portfolio
Increased support for OVHcloud products through service-specific commands.
“Yes” = full coverage, “Partial” = coverage is currently being enhanced.
| Category | Command/product | Coverage |
| Dedicated server/VPS | baremetal, vps | Yes |
| Public Cloud/Compute | instance | Yes |
| Public Cloud/containers | kube, rancher, container-registry | Yes |
| Public Cloud/databases | database, managed-databases | Partial |
| Public Cloud/analytics | managed-analytics | Partial |
| Public Cloud/storage | storage-s3, storage-swift, storage-block, storage | Yes |
| Public Cloud/network | loadbalancer, gateway, private, network, region, cssh-key, user, quota, cloud | Yes |
| Public Cloud/Data Platform | data platform | Partial |
| Public Cloud/AI and quantum solutions | ai deploy, ai training, ai notebook, quantum emulator, quantum qpu | Partial |
| Identity/access | iam, login | Partial |
| Private Cloud/hybrid | dedicated-cloud, dedicated-cluster, nutanix | Partial |
| Network | ip, vrack, iploadbalancing, ovhcloudconnect, cdn-dedicated | Partial |
| Domains/DNS/email/hosting | domain-name, domain-zone, email-mxplan, email-pro, webhosting, hosting-private-database | Partial |
| Backup/security/support | veeam*, ssl, okms, support-tickets, vmwareclouddirector-* | Partial |
Full list of commands: ovhcloud -h. Details: compatible products on GitHub.
Use cases and examples
Basic structure: ovhcloud [command] {sub-commands} {parameters}.
Output formats: table, JSON, YAML, or gval.
| Goal | Command |
| Log in and save your credentials | ovhcloud login |
| List the VPSs (table) | ovhcloud vps list |
| VPS details in JSON | ovhcloud vps get -o json |
| Reinstall a Bare Metal server (interactive mode) | ovhcloud baremetal reinstall --editor |
| List the instances and filter by region GRA9 | ovhcloud cloud instance list --filter 'region=="GRA9"' |
| Retrieve the ID of an MKS node pool by name | ovhcloud cloud kube nodepool list --filter 'name=="nodepool_name"' --format 'id' |
Useful global options: -o --output, -f, --format (gval expression), -h, --help.
You may find these useful
Use the terminal to manage all your cloud services
It’s easy to install (with a single command), open source, compatible with OpenStack, and fits right into the OVHcloud ecosystem. Try the CLI with no commitment.
Your questions answered
What can I do with the OVHcloud CLI?
The OVHcloud CLI allows you to manage your OVHcloud services via a terminal. You can, for example, list, create, edit, or delete services easily from the terminal. We’re still working on the CLI, so features and coverage will continue to expand over time.
What is the detailed list of services covered by the OVHcloud CLI?
The OVHcloud CLI is still in the works, so more features will be added. You can find out more by typing "ovhcloud -h" in the CLI.
How do I log in?
For more info on how to log in, refer to this documentation.
Is there any documentation available?
To get started with the OVHcloud CLI, go to our documentation centre. The Read me GitHub details the setup, login, and examples.
How do I easily log in?
The simplest way is "ovhcloud login", which interactively creates and saves your API credentials. You can also use a "~/.ovh.conf" file or environment variables for scripts and CI/CD.
Which products are fully supported by the CLI?
Products with full coverage (“Yes”) include Public Cloud instances, Kubernetes (MKS), Object Storage S3/Swift, Block Storage, Bare Metal, VPS, and IAM. Type "ovhcloud -h" for the up-to-date list of commands.