Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
d2de4c3
fix(service-info): send only the renewal settings the operator asked …
Denis-hamon Aug 18, 2026
84ec8a1
feat(vrack): attach and detach dedicated servers, and show what a vRa…
Denis-hamon Aug 19, 2026
d44f8a2
refactor(service-info): register the renewal flags from the command l…
Denis-hamon Aug 19, 2026
a33c9c5
chore: bring in the parent branch of the stack
Denis-hamon Aug 20, 2026
7fb060c
chore: no account data as test fixtures
Denis-hamon Aug 20, 2026
450ef1b
fix(baremetal): power status offered a --filter it can only ignore
Denis-hamon Aug 20, 2026
b26b6ba
chore: bring in the parent branch of the stack
Denis-hamon Aug 20, 2026
495ba24
chore: bring in the parent branch of the stack
Denis-hamon Aug 20, 2026
defd0c9
fix(vrack): vrack get printed nothing at all when one of its lists fa…
Denis-hamon Aug 20, 2026
87ed8e9
chore: bring in the parent branch of the stack
Denis-hamon Aug 20, 2026
6f780ef
fix(vrack): the summary counted interfaces and called them servers
Denis-hamon Aug 21, 2026
fa31991
fix(vrack): two content types were missing, and the name lookup read …
Denis-hamon Aug 21, 2026
f90f87d
chore: bring in the parent branch of the stack
Denis-hamon Aug 21, 2026
de251c4
chore: bring in the service-info flag registration from #243
Denis-hamon Aug 23, 2026
1a1bda3
fix(dry-run): stop printing the payload twice
Denis-hamon Aug 24, 2026
c421ef4
test: move the dry-run log tests to their own file
Denis-hamon Aug 24, 2026
d7ff8b2
Merge remote-tracking branch 'origin/feat/baremetal-confirm-reinstall…
Denis-hamon Aug 24, 2026
2cfde72
chore(doc): regenerate after bringing in the parent branch
Denis-hamon Aug 24, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 23 additions & 102 deletions doc/ovhcloud.md
Original file line number Diff line number Diff line change
@@ -1,90 +1,36 @@
# OVHcloud CLI (`ovhcloud`) Documentation
## ovhcloud

---
CLI to manage your OVHcloud services

## Overview
### Options

`ovhcloud` is a single, unified command‑line interface for managing the full range of OVHcloud products and account resources directly from your terminal. Whether you need to automate provisioning, perform quick look‑ups, or integrate OVHcloud operations into CI/CD pipelines, `ovhcloud` offers fine‑grained commands and consistent output formats (table, JSON, YAML, or custom gval expressions).

---

## Quick Start

```bash
# Display the top‑level help
ovhcloud --help

# Log in and create API credentials (interactive)
ovhcloud login

# List your VPS instances as JSON
ohvcloud vps list -o json
```

Check out the [authentication page](authentication.md) for further information about the authentication means.

You can manage multiple OVHcloud accounts using [profiles](profiles.md). Create a profile with `ovhcloud login --profile <name>`, switch between them with `ovhcloud config profile switch <name>`, or use `--profile <name>` on any command.

### Generate Shell Completion

```bash
# Bash
eval "$(./ovhcloud completion bash)"
# Zsh
eval "$(./ovhcloud completion zsh)"
# Fish
./ovhcloud completion fish | source
# PowerShell
./ovhcloud completion powershell | Out-String | Invoke-Expression
```

Add the appropriate line to your shell’s startup file (`~/.bashrc`, `~/.zshrc`, etc.) to enable persistent autocompletion.

---

## Global Usage

```text
ovhcloud [command] [flags]
-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 string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### Global Flags

| Flag | Description |
| ------------------ | ---------------------------------------------------- |
| `--debug` | Activate debug mode (logs all HTTP‑request details). |
| `--ignore-errors` | Ignore errors of API calls made when listing items. |
| `--filter <expr>` | Filter lists output with a [gval] expression. |
| `-h`, `--help` | Display help for `ovhcloud` or a specific command. |
| `-o interactive` | Produce interactive (prompt‑based) output. |
| `-o json` | Output data in JSON format. |
| `-o yaml` | Output data in YAML format. |
| `-o <expr>` | Format output with a [gval] expression. |

[gval]: https://github.com/PaesslerAG/gval

#### Filtering examples

- Strict string equality: `--filter 'name=="something"'`
- String regexp comparison: `--filter 'name=~"something"'`
- Number comparison: `--filter 'bootId > 1'`

#### Formatting example

- Extract only one field: `-o 'ip'`
- Extract an object: `-o '{name: ip}'`

---

## Command Reference

Below is the full list of primary sub‑commands available at the time of writing. Each can be explored in depth with `ovhcloud <command> --help`.
### SEE ALSO

* [ovhcloud account](ovhcloud_account.md) - Manage your account
* [ovhcloud alldom](ovhcloud_alldom.md) - Retrieve information and manage your AllDom services
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your Bare Metal services
* [ovhcloud browser](ovhcloud_browser.md) - Launch a TUI for the OVHcloud Manager - Public Cloud universe only [EXPERIMENTAL]
* [ovhcloud cdn-dedicated](ovhcloud_cdn-dedicated.md) - Retrieve information and manage your dedicated CDN services
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud completion](ovhcloud_completion.md) - Generate shell completion scripts
* [ovhcloud config](ovhcloud_config.md) - Manage your CLI configuration
* [ovhcloud dedicated-ceph](ovhcloud_dedicated-ceph.md) - Retrieve information and manage your Dedicated Ceph services
* [ovhcloud dedicated-cloud](ovhcloud_dedicated-cloud.md) - Retrieve information and manage your DedicatedCloud services
Expand All @@ -102,6 +48,7 @@ Below is the full list of primary sub‑commands available at the time of writin
* [ovhcloud ldp](ovhcloud_ldp.md) - Retrieve information and manage your LDP (Logs Data Platform) services
* [ovhcloud location](ovhcloud_location.md) - Retrieve information and manage your Location services
* [ovhcloud login](ovhcloud_login.md) - Login to your OVHcloud account to create API credentials
* [ovhcloud logout](ovhcloud_logout.md) - Revoke your API credentials and remove them from the configuration
* [ovhcloud nutanix](ovhcloud_nutanix.md) - Retrieve information and manage your Nutanix services
* [ovhcloud okms](ovhcloud_okms.md) - Retrieve information and manage your OKMS (Key Management Services)
* [ovhcloud overthebox](ovhcloud_overthebox.md) - Retrieve information and manage your OverTheBox services
Expand All @@ -113,6 +60,7 @@ Below is the full list of primary sub‑commands available at the time of writin
* [ovhcloud storage-netapp](ovhcloud_storage-netapp.md) - Retrieve information and manage your Storage NetApp services
* [ovhcloud support-tickets](ovhcloud_support-tickets.md) - Retrieve information and manage your support tickets
* [ovhcloud telephony](ovhcloud_telephony.md) - Retrieve information and manage your Telephony services
* [ovhcloud upgrade](ovhcloud_upgrade.md) - Upgrade OVHcloud CLI to the latest version
* [ovhcloud veeamcloudconnect](ovhcloud_veeamcloudconnect.md) - Retrieve information and manage your VeeamCloudConnect services
* [ovhcloud veeamenterprise](ovhcloud_veeamenterprise.md) - Retrieve information and manage your VeeamEnterprise services
* [ovhcloud version](ovhcloud_version.md) - Get OVHcloud CLI version
Expand All @@ -124,30 +72,3 @@ Below is the full list of primary sub‑commands available at the time of writin
* [ovhcloud webhosting](ovhcloud_webhosting.md) - Retrieve information and manage your WebHosting services
* [ovhcloud xdsl](ovhcloud_xdsl.md) - Retrieve information and manage your XDSL services

> **Tip**  Use `-o json`, `-o yaml`, or `-o <format>` with a gval expression to integrate `ovhcloud` into scripts and automation pipelines.

---

## 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` |

---

## Troubleshooting

* **Verbose output** — Use `--debug` to inspect raw API calls and responses.
* **Authentication issues** — Run `ovhcloud login` again to regenerate valid API keys.
* **Rate limits** — OVHcloud APIs impose rate limits; plan retries or exponential backoff in scripts.

---

## Further Reading

* OVHcloud API reference: [https://eu.api.ovh.com/console](https://eu.api.ovh.com/console)
* OVHcloud community guides and tutorials.
1 change: 1 addition & 0 deletions doc/ovhcloud_baremetal.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,5 @@ Retrieve information and manage your Bare Metal services
* [ovhcloud baremetal service-info](ovhcloud_baremetal_service-info.md) - Manage service information of the given baremetal
* [ovhcloud baremetal terminate](ovhcloud_baremetal_terminate.md) - Ask for the termination of the given baremetal
* [ovhcloud baremetal vni](ovhcloud_baremetal_vni.md) - Manage Virtual Network Interfaces of the given baremetal
* [ovhcloud baremetal vrack](ovhcloud_baremetal_vrack.md) - Attach the given baremetal to a vRack, or detach it

36 changes: 36 additions & 0 deletions doc/ovhcloud_baremetal_vrack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## ovhcloud baremetal vrack

Attach the given baremetal to a vRack, or detach it

### Options

```
-h, --help help for vrack
```

### Options inherited from parent commands

```
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your Bare Metal services
* [ovhcloud baremetal vrack attach](ovhcloud_baremetal_vrack_attach.md) - Attach the given baremetal to a vRack
* [ovhcloud baremetal vrack detach](ovhcloud_baremetal_vrack_detach.md) - Detach the given baremetal from its vRack
* [ovhcloud baremetal vrack show](ovhcloud_baremetal_vrack_show.md) - Show the vRack the given baremetal is in

42 changes: 42 additions & 0 deletions doc/ovhcloud_baremetal_vrack_attach.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
## ovhcloud baremetal vrack attach

Attach the given baremetal to a vRack

```
ovhcloud baremetal vrack attach <service_name> <vrack> [flags]
```

### Options

```
--dry-run Print the call that would be made without making it
-h, --help help for attach
--interface string Interface to attach, when the server has several
--timeout duration How long --wait waits (default 10m0s)
--wait Wait until the vRack reports the change before exiting
-y, --yes Skip the confirmation prompt (required for unattended runs)
```

### Options inherited from parent commands

```
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud baremetal vrack](ovhcloud_baremetal_vrack.md) - Attach the given baremetal to a vRack, or detach it

41 changes: 41 additions & 0 deletions doc/ovhcloud_baremetal_vrack_detach.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## ovhcloud baremetal vrack detach

Detach the given baremetal from its vRack

```
ovhcloud baremetal vrack detach <service_name> [vrack] [flags]
```

### Options

```
--dry-run Print the call that would be made without making it
-h, --help help for detach
--timeout duration How long --wait waits (default 10m0s)
--wait Wait until the vRack reports the change before exiting
-y, --yes Skip the confirmation prompt (required for unattended runs)
```

### Options inherited from parent commands

```
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud baremetal vrack](ovhcloud_baremetal_vrack.md) - Attach the given baremetal to a vRack, or detach it

37 changes: 37 additions & 0 deletions doc/ovhcloud_baremetal_vrack_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## ovhcloud baremetal vrack show

Show the vRack the given baremetal is in

```
ovhcloud baremetal vrack show <service_name> [flags]
```

### Options

```
-h, --help help for show
```

### Options inherited from parent commands

```
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud baremetal vrack](ovhcloud_baremetal_vrack.md) - Attach the given baremetal to a vRack, or detach it

46 changes: 46 additions & 0 deletions doc/ovhcloud_logout.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
## ovhcloud logout

Revoke your API credentials and remove them from the configuration

```
ovhcloud logout [flags]
```

### Examples

```
ovhcloud logout
ovhcloud logout --yes
ovhcloud logout --profile work
```

### Options

```
-h, --help help for logout
-y, --yes Do not ask for confirmation
```

### Options inherited from parent commands

```
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud](ovhcloud.md) - CLI to manage your OVHcloud services

2 changes: 2 additions & 0 deletions doc/ovhcloud_vrack.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ Retrieve information and manage your vRack services
### SEE ALSO

* [ovhcloud](ovhcloud.md) - CLI to manage your OVHcloud services
* [ovhcloud vrack attach](ovhcloud_vrack_attach.md) - Attach a dedicated server to the given vRack
* [ovhcloud vrack detach](ovhcloud_vrack_detach.md) - Detach a dedicated server from the given vRack
* [ovhcloud vrack edit](ovhcloud_vrack_edit.md) - Edit the given vRack
* [ovhcloud vrack get](ovhcloud_vrack_get.md) - Retrieve information of a specific vRack
* [ovhcloud vrack list](ovhcloud_vrack_list.md) - List your vRackservices
Expand Down
Loading
Loading