Compare commits

...

95 commits
v0.4.0 ... main

Author SHA1 Message Date
anthony berger
f71e5d4e28
Add attachFloatinIps spec on nodepool (#107)
Some checks failed
Build and test / build (1.24.x) (push) Has been cancelled
Build and test / build (1.25.x) (push) Has been cancelled
* feat : add attachFloatinIps
2025-12-15 16:44:24 +01:00
Arthur Amstutz
bef8a80c37
Merge pull request #117 from ovh/dev/aamstutz/move-lb-commands
Some checks failed
Build and test / build (1.24.x) (push) Has been cancelled
Build and test / build (1.25.x) (push) Has been cancelled
fix: Move cloud loadbalancer command under network
2025-12-11 17:30:15 +01:00
Arthur Amstutz
76a1096814
fix: Move cloud loadbalancer command under network
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-12-11 15:37:02 +00:00
Théo Brigitte
08eb50e6bb
Add domain-zone record create and delete, commands (#108)
Add domain-zone record create, command
2025-12-11 16:05:15 +01:00
Arthur Amstutz
227a97bed8
Merge pull request #113 from ovh/dev/aamstutz/fix-cloudshell-path
Some checks failed
Build and test / build (1.24.x) (push) Has been cancelled
Build and test / build (1.25.x) (push) Has been cancelled
fix: Add /v1 prefix to API calls
2025-12-05 11:13:56 +01:00
Arthur Amstutz
e38e4e89e3
Merge pull request #114 from ovh/dev/aamstutz/improve-readme
doc: Display interactive login first in readme
2025-12-05 11:13:03 +01:00
Arthur Amstutz
2aa7c5aed2
doc: Display interactive login first in readme
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-12-05 08:50:46 +00:00
Arthur Amstutz
13a79b2fd4
fix: Add /v1 prefix to API calls
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-12-04 17:53:41 +00:00
Arthur Amstutz
8a58508686
Merge pull request #112 from ovh/dev/aamstutz/fix-loadbalancer-get
Some checks failed
Build and test / build (1.24.x) (push) Has been cancelled
Build and test / build (1.25.x) (push) Has been cancelled
fix(cloud_loadbalancer): Improve displayed info
2025-12-03 17:08:48 +01:00
Arthur Amstutz
16309bffca
Merge pull request #110 from TheoBrigitte/add-make-build
Add make build target
2025-12-03 16:17:19 +01:00
Arthur Amstutz
f97280af4f
fix(cloud_loadbalancer): Improve displayed info
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-12-03 15:10:28 +00:00
Arthur Amstutz
386cd24f22
Merge pull request #109 from TheoBrigitte/wordwrap-increase
Increase word wrap with auto-detected terminal width
2025-12-03 15:37:02 +01:00
Theo Brigitte
ac763d8595
Add make build target
Signed-off-by: Theo Brigitte <theo.brigitte@gmail.com>
2025-12-01 10:43:29 +01:00
Theo Brigitte
5a58a2e8da
Address reviews
Signed-off-by: Theo Brigitte <theo.brigitte@gmail.com>
2025-11-30 00:15:10 +01:00
Theo Brigitte
e20a532d65
Increase word wrap with auto-detect terminal width
Signed-off-by: Theo Brigitte <theo.brigitte@gmail.com>
2025-11-29 02:16:22 +01:00
Arthur Amstutz
75454fc612
Merge pull request #105 from ovh/dev/aamstutz/add-missing-iam-policy-cmds
Some checks failed
Build and test / build (1.24.x) (push) Has been cancelled
Build and test / build (1.25.x) (push) Has been cancelled
feat(iam): Add missing commands to manage policies
2025-11-28 11:50:41 +01:00
Arthur Amstutz
00c6354b79
feat(iam): Add missing commands to manage policies
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-11-27 16:54:40 +00:00
Arthur Amstutz
0a7ae816da
Merge pull request #103 from ovh/dev/aamstutz/add-iam-token-cmds
Some checks failed
Build and test / build (1.24.x) (push) Has been cancelled
Build and test / build (1.25.x) (push) Has been cancelled
feat(iam): Add commands to manage user tokens
2025-11-27 16:43:32 +01:00
Arthur Amstutz
cd3f7a2f81
feat(iam): Add commands to manage user tokens
Some checks failed
Build and test / build (1.24.x) (push) Has been cancelled
Build and test / build (1.25.x) (push) Has been cancelled
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-11-27 14:05:04 +00:00
Arthur Amstutz
ba7f6f0479
Merge pull request #102 from ovh/dev/aamstutz/fix-version-message
Some checks are pending
Build and test / build (1.25.x) (push) Waiting to run
Build and test / build (1.24.x) (push) Waiting to run
fix(version): Use last tag instead of version from Goreleaser
2025-11-27 08:50:27 +01:00
Arthur Amstutz
70aa899a16
fix(version): Use last tag instead of version from Goreleaser
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-11-27 06:44:01 +00:00
Arthur Amstutz
f0b6257283
Merge pull request #97 from ovh/dev/aamstutz/fix-instance-units
Some checks are pending
Build and test / build (1.24.x) (push) Waiting to run
Build and test / build (1.25.x) (push) Waiting to run
fix(instance): Wrong units in template
2025-11-26 17:11:25 +01:00
Arthur Amstutz
2994d969a8
fix(instance): Wrong units in template
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-11-25 08:05:21 +00:00
Arthur Amstutz
fb23dd36fb
Merge pull request #90 from ovh/dev/aamstutz/improve-contributing
Some checks failed
Build and test / build (1.24.x) (push) Has been cancelled
Build and test / build (1.25.x) (push) Has been cancelled
doc: Improve contributing documentation
2025-11-24 11:42:20 +01:00
Arthur Amstutz
793e9bb2c5
doc: Improve contributing documentation
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-11-18 14:02:24 +00:00
Arthur Amstutz
44bc4f7d48
Merge pull request #86 from ovh/dev/aamstutz/add-iam-user-cmds
Some checks failed
Build and test / build (1.24.x) (push) Has been cancelled
Build and test / build (1.25.x) (push) Has been cancelled
feat(iam): Add commands to manage local users
2025-11-10 08:29:02 +01:00
Arthur Amstutz
a505219616
feat(iam): Add commands to manage local users
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-11-07 20:39:08 +00:00
Romain Beuque
531b75b858
Merge pull request #82 from ovh/cds
Some checks failed
Build and test / build (1.24.x) (push) Has been cancelled
Build and test / build (1.25.x) (push) Has been cancelled
fix: cds: update workflow to release docker images
2025-10-31 17:34:50 +01:00
Romain Beuque
065610e8ad
fix: cds: update workflow to release docker images
Signed-off-by: Romain Beuque <romain.beuque@ovhcloud.com>
2025-10-31 16:29:05 +00:00
Arthur Amstutz
e309d088f1
Merge pull request #78 from ovh/dev/aamstutz/fix-baremetal-compatible-os
fix: Avoid panic when listing baremetal compatible OSes
2025-10-22 10:22:00 +02:00
Arthur Amstutz
487e575a3a
fix: Avoid panic when listing baremetal compatible OSes
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-10-22 07:38:11 +00:00
Arthur Amstutz
6c8706a74c
Merge pull request #77 from ovh/scraly-patch-3
README: put together the 3 services of containers and orchestration
2025-10-20 15:50:24 +02:00
Aurelie Vache
87b6c2c5eb
README: put together the 3 services of containers and orchestration
Signed-off-by: Aurelie Vache <scraly@gmail.com>
2025-10-20 15:46:35 +02:00
Arthur Amstutz
a4d9bc63bd
Merge pull request #76 from ovh/dev/aamstutz/openrc
feat: Use OS_TENANT_ID env variable to define public cloud project to use
2025-10-17 17:56:55 +02:00
Arthur Amstutz
b211cdd269
feat: Use OS_TENANT_ID env variable to define public cloud project to use
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-10-17 15:38:09 +00:00
Arthur Amstutz
00ac488093
Merge pull request #75 from ovh/dev/aamstutz/check-new-version
feat: Check for new version of the CLI when running commands
2025-10-17 17:15:17 +02:00
Arthur Amstutz
49fa000136
feat: Check for new version of the CLI when running commands
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-10-17 14:37:53 +00:00
Arthur Amstutz
9a94a221db
Merge pull request #74 from ovh/dev/aamstutz/instance-handle-null-image
fix: Handle case when image is nil when fetching an instance
2025-10-17 10:39:41 +02:00
Arthur Amstutz
8b3ccdda3c
fix: Handle case when image is nil when fetching an instance
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-10-17 08:24:39 +00:00
Romain Beuque
2a76f09043
Merge pull request #73 from ovh/dev/aamstutz/pci-distant-snapshot
feat: Add cloud instance snapshots commands
2025-10-16 14:44:27 +02:00
Arthur Amstutz
0f7f987296
feat: Add cloud instance snapshots commands
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-10-16 09:46:04 +00:00
Arthur Amstutz
245507139d
Merge pull request #71 from ovh/dev/aamstutz/hide-nil-tables
fix: Avoid displaying <nil> in tables
2025-10-15 10:16:54 +02:00
Arthur Amstutz
0630a5e748
Merge pull request #69 from ovh/dev/aamstutz/right-loadbalancers
fix: Use the right kind of public cloud loadbalancer
2025-10-15 10:16:41 +02:00
Arthur Amstutz
20f1077931
fix: Avoid displaying <nil> in tables
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-10-14 14:35:43 +00:00
Arthur Amstutz
8d341f8ccb
Merge pull request #64 from thcdrt/dev/thcdrt/rancher-improve-create-and-edit
Improve Rancher create and edit
2025-10-14 16:16:58 +02:00
Arthur Amstutz
3bb2bfa54e
Merge branch 'main' into dev/aamstutz/right-loadbalancers
Signed-off-by: Arthur Amstutz <18141571+amstuta@users.noreply.github.com>
2025-10-14 16:00:32 +02:00
Arthur Amstutz
9a3f5459ce
Merge pull request #70 from ovh/dev/aamstutz/filter-columns-wasm
feat: Filter table columns in WASM mode
2025-10-14 15:55:09 +02:00
Arthur Amstutz
450e8cd5a5
feat: Filter table columns in WASM mode
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-10-14 13:47:58 +00:00
Thomas Coudert
d981c56e90
feat: Add Rancher edit iam-auth-enabled option and remove iprestrictions
Signed-off-by: Thomas Coudert <thomas.coudert@ovhcloud.com>
2025-10-14 15:40:23 +02:00
Thomas Coudert
05f4f5e90e
feat: Update cloud_v2.json api-schema file
Signed-off-by: Thomas Coudert <thomas.coudert@ovhcloud.com>
2025-10-14 15:34:50 +02:00
Arthur Amstutz
9bd8c36251
Merge pull request #63 from thcdrt/dev/thcdrt/rancher-reset-admin-credentials
feat: Add Rancher reset-admin-credentials command
2025-10-14 14:29:54 +02:00
Thomas Coudert
6f5d45a937
feat: Add Rancher reset-admin-credentials command
Signed-off-by: Thomas Coudert <thomas.coudert@ovhcloud.com>
2025-10-14 14:22:27 +02:00
Arthur Amstutz
9b126429a7
fix: Use the right kind of public cloud loadbalancer
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-10-14 12:10:22 +00:00
Arthur Amstutz
922181f6eb
Merge pull request #68 from ovh/dev/aamstutz/fix-wasm-output
fix: Output JSON in WASM binary
2025-10-13 18:17:05 +02:00
Arthur Amstutz
9db6611d63
Merge pull request #67 from ovh/dev/aamstutz/s3-bulk-delete
feat: Add options to s3 objects bulk-delete command
2025-10-13 18:16:45 +02:00
Arthur Amstutz
c94bf81d77
fix: Output JSON in WASM binary
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-10-13 16:14:16 +00:00
Arthur Amstutz
b13294cb32
Merge pull request #62 from thcdrt/dev/thcdrt/fix-readme-typo
doc: Fix README build target
2025-10-13 17:58:23 +02:00
Arthur Amstutz
27b69c7097
feat: Add options to s3 objects bulk-delete command
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-10-13 15:50:23 +00:00
Arthur Amstutz
e35a8f0290
Merge pull request #66 from ovh/dev/aamstutz/fix-s3-bulk-del-help
doc: Fix s3 bulk-delete help + update docs
2025-10-13 10:42:03 +02:00
Arthur Amstutz
5cbfefdff8
doc: Fix s3 bulk-delete help + update docs
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-10-13 08:33:41 +00:00
Arthur Amstutz
1cabe6c5d8
Merge pull request #65 from ovh/readme
chore: readme: fix homebrew installation process + add install from source
2025-10-13 09:49:29 +02:00
Romain Beuque
c2c17ad04c chore: readme: fix homebrew installation process + add install from source
Fixes #58

Signed-off-by: Romain Beuque <556072+rbeuque74@users.noreply.github.com>
2025-10-12 17:59:48 +02:00
Thomas Coudert
b3cd2b1505
doc: Fix README build target
Signed-off-by: Thomas Coudert <thomas.coudert@ovhcloud.com>
2025-10-10 14:19:32 +02:00
Marie JONES
747c4746c8
Merge pull request #53 from pgaxatte/main
fix(login): extend fields width to prevent horizontal scroll
2025-10-07 10:04:16 +02:00
Marie JONES
e1af7e75cd
Merge pull request #54 from antleblanc/patch-1
doc: Fix contributing url
2025-10-07 10:03:29 +02:00
mxpetit
1f5746eb3f
Merge pull request #51 from ovh/dev/mapetit/dns-zone-update-refresh
feat: add DNS zone refresh and record update commands
2025-10-07 09:49:20 +02:00
Antoine Leblanc
559ed2fe15
doc: Fix contributing url
Signed-off-by: Antoine Leblanc <antoine.leblanc@ovhcloud.com>
2025-10-06 18:45:28 +02:00
Maxime PETIT
10c94e2cf4
feat: add DNS zone refresh and record update commands
Signed-off-by: Maxime PETIT <18697599+mxpetit@users.noreply.github.com>
2025-10-03 13:46:26 +02:00
Pierre Gaxatte
ebf6230cb9
fix(login): extend fields width to prevent horizontal scroll
Signed-off-by: Pierre Gaxatte <pierre.gaxatte@ovhcloud.com>
2025-10-03 11:04:08 +02:00
Arthur Amstutz
546f3c8281
Merge pull request #50 from ovh/dev/aamstutz/readme-update
doc: Fix README missing TOC
2025-10-02 12:09:34 +02:00
Arthur Amstutz
2d4a7db64f
doc: Fix README missing TOC
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-10-02 10:03:30 +00:00
Arthur Amstutz
748d65f601
Merge pull request #49 from ovh/dev/aamstutz/readme-update
doc: Add products list in README + update badges
2025-10-02 11:46:50 +02:00
Arthur Amstutz
42839167ac
doc: Add products list in README + update badges
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-10-02 09:44:01 +00:00
Arthur Amstutz
5b7c163439
Merge pull request #48 from ovh/bindir
feat: accept $BINDIR as target dir, as well as $XDG_BIN_HOME & $HOME/.local/bin
2025-10-02 10:43:50 +02:00
Maxime Soulé
ef5296f430
feat: accept $BINDIR as target dir, as well as $XDG_BIN_HOME & $HOME/.local/bin
Signed-off-by: Maxime Soulé <btik-git@scoubidou.com>
2025-10-02 10:28:22 +02:00
Arthur Amstutz
69a764f27e
Merge pull request #47 from ovh/dev/aamstutz/subnet-creation
feat: Add cloud subnet creation command
2025-10-01 15:15:50 +02:00
Arthur Amstutz
6f853e329c
feat: Add cloud subnet creation command
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-10-01 12:47:22 +00:00
Arthur Amstutz
01daa0dd4b
Merge pull request #46 from ovh/dev/aamstutz/add-missing-badges
chore: Add badges for Alpine package and FreeBSD port
2025-10-01 10:32:18 +02:00
Arthur Amstutz
3136d428ad
chore: Add badges for Alpine package and FreeBSD port
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-10-01 08:28:34 +00:00
Arthur Amstutz
f3f5c3af1c
Merge pull request #44 from ovh/dev/aamstutz/fix-workflow
chore: Add events that trigger the build workflow
2025-09-30 10:56:59 +02:00
Arthur Amstutz
ba9723ff3f
chore: Add events that trigger the build workflow
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-09-30 08:50:37 +00:00
Arthur Amstutz
a495e590a3
Merge pull request #41 from mJehanno/add-me
feat(me): add me command to get information about the current user
2025-09-30 10:43:32 +02:00
mJehanno
41bd2dd54c
feat(me): add me command to get information about the current user
Signed-off-by: mJehanno <mathob.jehanno@hotmail.fr>
2025-09-30 10:21:27 +02:00
Arthur Amstutz
6d42e50c4d
Merge pull request #39 from ovh/ava-rename-services
feat: services renaming/improving
2025-09-29 14:45:42 +02:00
scraly
b42af9ca11 feat: services renaming/improving
Signed-off-by: scraly <scraly@gmail.com>
2025-09-29 13:56:02 +02:00
Arthur Amstutz
aca11ab46b
Merge pull request #36 from ovh/dev/aamstutz/fix-homebrew-cask
fix: Avoid using homebrew_curl in generated Cask
2025-09-29 11:38:54 +02:00
Arthur Amstutz
c772ffb9fa
fix: Avoid using homebrew_curl in generated Cask
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-09-29 09:25:16 +00:00
Arthur Amstutz
2f6a6bb038
Merge pull request #35 from ovh/scraly-patch-2
[README] Fix: auto-completion commands
2025-09-29 11:00:11 +02:00
Arthur Amstutz
5ae22021c2
Merge pull request #33 from ovh/dev/aamstutz/cloud-network-fix
feat: Add subnet+gateway information in output when creating a private network
2025-09-29 10:59:06 +02:00
Aurelie Vache
eab12dbefe
Fix: auto-completion commands
Signed-off-by: Aurelie Vache <scraly@gmail.com>
2025-09-29 10:46:45 +02:00
Arthur Amstutz
d5aaecb075
feat: Add subnet+gateway information in output when creating a private network
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-09-29 08:42:30 +00:00
Arthur Amstutz
3e6332668a
Merge pull request #34 from ovh/dev/aamstutz/fix-install-script
fix: Installation script use right URL
2025-09-29 09:24:13 +02:00
Arthur Amstutz
47973500a2
fix: Installation script use right URL
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-09-29 07:21:09 +00:00
Arthur Amstutz
5200a491e5
Merge pull request #32 from ovh/dev/aamstutz/fix-doc-clouddb
doc: Fix Cloud DB doc
2025-09-26 17:46:00 +02:00
Arthur Amstutz
d2e50e13b3
doc: Fix Cloud DB doc
Signed-off-by: Arthur Amstutz <arthur.amstutz@corp.ovh.com>
2025-09-26 14:28:19 +00:00
215 changed files with 9075 additions and 1533 deletions

View file

@ -47,7 +47,7 @@ jobs:
release:
needs:
- push-docker-image
if: git.ref_name == 'main'
if: '${{ git.ref_type == ''tag'' && success() }}'
runs-on:
model: library/default-container
steps:

View file

@ -1,6 +1,6 @@
name: Build and test
on: [push]
on: [push, workflow_dispatch, pull_request]
jobs:
build:

View file

@ -19,7 +19,7 @@ builds:
env:
- CGO_ENABLED=0
ldflags:
- -s -w -extldflags -static -X github.com/ovh/ovhcloud-cli/internal/version.Version={{.Version}}
- -s -w -extldflags -static -X github.com/ovh/ovhcloud-cli/internal/version.Version={{.Tag}}
goos:
- linux
- windows
@ -31,7 +31,7 @@ builds:
env:
- CGO_ENABLED=0
ldflags:
- -s -w -extldflags -static -X github.com/ovh/ovhcloud-cli/internal/version.Version={{.Version}}
- -s -w -extldflags -static -X github.com/ovh/ovhcloud-cli/internal/version.Version={{.Tag}}
goos:
- js
goarch:
@ -69,7 +69,6 @@ homebrew_casks:
binary: ovhcloud
url:
template: "https://github.com/ovh/ovhcloud-cli/releases/download/{{ .Tag }}/{{ .ArtifactName }}"
using: ":homebrew_curl"
repository:
owner: ovh
name: homebrew-tap

View file

@ -1,4 +1,4 @@
Thanks for wanting to contribute to this project ❤️.
Thank you for wanting to contribute to this project ❤️
This project accepts contributions. In order to contribute, you should pay attention to a few things:
@ -7,19 +7,98 @@ This project accepts contributions. In order to contribute, you should pay atten
3. Your code must be tested
4. GitHub Pull Requests
## Coding and documentation Style:
The following sections explain in details the contribution guidelines.
# Table of content
- [Submitting Modifications](#submitting-modifications)
- [Submitting an Issue](#submitting-an-issue)
- [Coding and Documentation Style](#coding-and-documentation-style)
- [Adding a New CLI Feature](#adding-a-new-cli-feature)
- [1. Service (Business Logic)](#1-service-business-logic)
- [2. CLI Command](#2-cli-command)
- [3. Create / Edit Command UX Flags](#3-create--edit-command-ux-flags)
- [4. Documentation](#4-documentation)
- [5. Tests](#5-tests)
- [6. Typical Structure Example](#6-typical-structure-example)
- [7. Checklist Before Opening a PR](#7-checklist-before-opening-a-pr)
- [Developer Certificate of Origin (DCO)](#developer-certificate-of-origin-dco)
# Submitting Modifications:
The contributions should be submitted through new GitHub Pull Requests.
# Submiting an Issue:
In addition to contributions, we welcome [bug reports, feature requests and documentation error reports](https://github.com/ovh/ovhcloud-cli/issues/new).
# Coding and documentation Style:
- Code must be formatted with `make fmt` command
- Name your commands according to the API endpoint
- If the input body of an API call has more than five parameters or has more than one level of nesting, the corresponding CLI command must have flags '--editor' and '--from-file' to define its parameters.
## Submitting Modifications:
# Adding a new CLI Feature
The contributions should be submitted through new GitHub Pull Requests.
This document explains the minimal workflow to add a new feature to the CLI.
## Submiting an Issue:
## 1. Service (Business Logic)
In addition to contributions, we welcome [bug reports, feature requests and documentation error reports](https://github.com/ovh/ovhcloud-cli/issues/new).
Place all code that performs HTTP calls and processes responses in a dedicated sub-package under:
`internal/services/<yourservice>`.
Any logic related to printing or formatting output should be handled by the separate `internal/display` package, which must be used for presenting results or errors to the user. This package handles the formatting depending on the output asked by the user (JSON, YAML, …).
## 2. CLI Command
Add the corresponding command in: `internal/cmd/<yourservice>.go`.
Follow existing patterns for command registration and use cohesive, single-purpose files.
## 3. Create / Edit Command UX Flags
For resource creation or edition commands, you MUST support:
- `--editor` open a temporary spec in $EDITOR
- `--init-file` create a skeleton file
- `--from-file` load full request body from a file
Helper functions already exist to add these flags. See the IAM user creation implementation for reference.
## 4. Documentation
After adding or modifying commands, regenerate docs from the repository root:
```bash
make doc
```
Don't commit changed made to `doc/ovhcloud.md` except if they are manual changes.
## 5. Tests
Add tests for the new command(s) in: `internal/cmd/<yourservice>_test.go` Focus on:
- Flag parsing
- Error paths
- Testing the successful execution path by invoking the service layer using mocks
## 6. Typical Structure Example
```
internal/services/policy/ # HTTP + response handling
internal/cmd/policy/ # cobra command definitions
doc/ovhcloud_<generated>.md # regenerated via make doc
```
## 7. Checklist Before Opening a PR
- Service code isolated in internal/services
- Command code added in internal/cmd
- Supports required create/edit flags (if applicable)
- Docs regenerated (make doc)
- Tests added and passing
- Lint/build succeeds (make build)
- Keep changes small and consistent with existing patterns
- Prefer commands that are limited to a single use-case and do not require excessive HTTP calls
# Developer Certificate of Origin (DCO)

View file

@ -6,7 +6,9 @@ LD_PKG = $(shell go list ./internal/version)
LD_FLAGS = -s -w -extldflags -static -X ${LD_PKG}.Version=${VERSION}
BUILD_CMD = CGO_ENABLED=0 go build
all:
all: build
build:
${BUILD_CMD} -ldflags "${LD_FLAGS}" -o ovhcloud ./cmd/ovhcloud
wasm:
@ -20,6 +22,7 @@ fmt:
doc:
go run cmd/docgen/main.go
git checkout doc/ovhcloud.md
release-snapshot:
goreleaser release --snapshot --clean --parallelism 1
@ -27,4 +30,4 @@ release-snapshot:
release:
goreleaser release --clean
.PHONY: all wasm doc
.PHONY: all wasm doc

120
README.md
View file

@ -2,10 +2,13 @@
[![License](https://img.shields.io/github/license/ovh/ovhcloud-cli)](LICENSE)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/ovh/ovhcloud-cli)](https://github.com/ovh/ovhcloud-cli/releases/latest)
[![Homebrew](https://img.shields.io/badge/dynamic/regex?url=https%3A%2F%2Fraw.githubusercontent.com%2Fovh%2Fhomebrew-tap%2Frefs%2Fheads%2Fmain%2FCasks%2Fovhcloud-cli.rb&search=version%20%22%28%3F%3Cversion%3E%5B%5E%22%5D%2B%29%22&replace=%24%3Cversion%3E&label=homebrew)](#install-using-homebrew)
[![Release Date](https://img.shields.io/github/release-date/ovh/ovhcloud-cli)](https://github.com/ovh/ovhcloud-cli/releases)
[![Download Count](https://img.shields.io/github/downloads/ovh/ovhcloud-cli/total.svg)](https://github.com/ovh/ovhcloud-cli/releases/latest)
[![Discord](https://img.shields.io/badge/Discord-ovhcloud-blue.svg)](https://discord.gg/ovhcloud)
[![Packaging status](https://repology.org/badge/vertical-allrepos/ovhcloud-cli.svg)](https://repology.org/project/ovhcloud-cli/versions)
`ovhcloud` is a single, unified commandline interface for managing the full range of OVHcloud products and account resources directly from your terminal. Whether you need to automate provisioning, perform quick lookups, or integrate OVHcloud operations into CI/CD pipelines, `ovhcloud` offers finegrained commands and consistent output formats (table, JSON, YAML, or custom gval expressions).
# Table of Contents
@ -15,9 +18,11 @@
- [Binary download](#binary-download)
- [Run with Docker](#run-with-docker)
- [Install using HomeBrew](#install-using-homebrew)
- [Install from the source](#install-from-the-source)
- [Usage](#usage)
- [Authenticating the CLI](#authenticating-the-cli)
- [Examples](#examples)
- [Available products](#available-products)
- [Generate Shell Completion](#generate-shell-completion)
- [Contributing](#contributing)
- [Build](#build)
@ -49,10 +54,18 @@ You can also run the CLI using Docker:
docker run -it --rm -v ovhcloud-cli-config-files:/config ovhcom/ovhcloud-cli login
```
## Install using HomeBrew
## Install using Homebrew
```sh
brew install ovh/tap/ovhcloud-cli
brew install --cask ovh/tap/ovhcloud-cli
```
## Install from the source
Requires Go to be installed on your system.
```sh
go install github.com/ovh/ovhcloud-cli/cmd/ovhcloud@latest
```
# Usage
@ -67,9 +80,9 @@ Available commands:
```
account Manage your account
alldom Retrieve information and manage your AllDom services
baremetal Retrieve information and manage your baremetal services
baremetal Retrieve information and manage your Bare Metal services
cdn-dedicated Retrieve information and manage your dedicated CDN services
cloud Manage your projects and services in the Public Cloud universe
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
@ -84,15 +97,15 @@ Available commands:
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 IpLoadbalancing services
ldp Retrieve information and manage your Ldp services
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 OvhCloudConnect 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
@ -103,8 +116,8 @@ Available commands:
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 VmwareCloudDirectorBackup services
vmwareclouddirector-organization Retrieve information and manage your VmwareCloudDirector Organizations
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
@ -130,6 +143,12 @@ OVHcloud CLI requires authentication to be able to make API calls. There are sev
Check out the [authentication page](./doc/authentication.md) for further information about the configuration and the authentication means.
* Interactive login:
```sh
# Log in and create API credentials (interactive)
ovhcloud login
```
* Using a configuration file:
Default settings can be set using a configuration file named `.ovh.conf` and located in your `${HOME}` directory.
@ -158,12 +177,6 @@ OVH_CONSUMER_KEY=xxx
OVH_CLOUD_PROJECT_SERVICE=<public cloud project ID>
```
* Interactive login:
```sh
# Log in and create API credentials (interactive)
ovhcloud login
```
## Examples
| Task | Command |
@ -174,17 +187,80 @@ ovhcloud login
| Reinstall a baremetal interactively | `ovhcloud baremetal reinstall <id> --editor` |
| List instances and filter on GRA9 region | `ovhcloud cloud instance list --filter 'region=="GRA9"'`|
# Available products
| Category | Command | Covered |
|---------------------------------------|---------------------------------|------------|
| **Backup** | veeamcloudconnect | Partially |
| | veeamenterprise | Partially |
| **Communication** | sms | Partially |
| | telephony | Partially |
| **Compute / Dedicated / VPS** | baremetal | Yes |
| | vps | Yes |
| **Connectivity** | pack-xdsl | Partially |
| | xdsl | Partially |
| **Domains / DNS** | alldom | Partially |
| | domain-name | Partially |
| | domain-zone | Partially |
| **Email** | email-domain | Partially |
| | email-mxplan | Partially |
| | email-pro | Partially |
| **Hybrid Cloud** | nutanix | Partially |
| **Hosting** | webhosting | Partially |
| | hosting-private-database | Partially |
| **Identity / Account / Access** | account | Partially |
| | iam | Yes |
| | login | Partially |
| **Infra Meta** | location | Partially |
| **Network** | ip | Partially |
| | overthebox | Partially |
| | vrack | Partially |
| | vrackservices | Partially |
| **Network / Acceleration** | cdn-dedicated | Partially |
| **Network / Connectivity** | ovhcloudconnect | Partially |
| **Network / Load Balancing** | iploadbalancing | Partially |
| **Observability** | ldp | Partially |
| **Private Cloud** | dedicated-cloud | Partially |
| | dedicated-cluster | Partially |
| **Public Cloud / Access** | cloud ssh-key | Yes |
| **Public Cloud / Compute** | cloud instance | Yes |
| **Public Cloud / Container Registry** | cloud container-registry | Yes |
| **Public Cloud / Containers** | cloud kube | Yes |
| **Public Cloud / Orchestration** | cloud rancher | Yes |
| **Public Cloud / Databases** | cloud database-service | Partially |
| **Public Cloud / Governance** | cloud quota | Yes |
| **Public Cloud / Meta** | cloud reference | Yes |
| | cloud region | Yes |
| **Public Cloud / Network** | cloud loadbalancer | Partially |
| | cloud network | Yes |
| **Public Cloud / Object Storage** | cloud storage-s3 | Yes |
| | cloud storage-swift | Yes |
| **Public Cloud / Ops** | cloud operation | Yes |
| **Public Cloud / Project** | cloud project | Yes |
| **Public Cloud / Storage** | cloud storage-block | Yes |
| **Public Cloud / Identity** | cloud user | Yes |
| **Security** | ssl | Partially |
| | okms | Partially |
| **Security / Edge** | ssl-gateway | Partially |
| **Storage** | dedicated-ceph | Partially |
| | dedicated-nasha | Partially |
| | storage-netapp | Partially |
| **Support** | support-tickets | Partially |
| **VMware** | vmwareclouddirector-organization| Partially |
| | vmwareclouddirector-backup | Partially |
|---------------------------------------|---------------------------------|------------|
# Generate Shell Completion
```sh
# Bash
eval "$(./ovhcloud completion bash)"
eval "$(ovhcloud completion bash)"
# Zsh
eval "$(./ovhcloud completion zsh)"
eval "$(ovhcloud completion zsh)"
# Fish
./ovhcloud completion fish | source
ovhcloud completion fish | source
# PowerShell
./ovhcloud completion powershell | Out-String | Invoke-Expression
ovhcloud completion powershell | Out-String | Invoke-Expression
```
Add the appropriate line to your shells startup file (`~/.bashrc`, `~/.zshrc`, etc.) to enable persistent autocompletion.
@ -193,13 +269,13 @@ Add the appropriate line to your shells startup file (`~/.bashrc`, `~/.zshrc`
You've developed a new cool feature? Fixed an annoying bug? We'd be happy to hear from you, there are no small contributions!
Have a look in [CONTRIBUTING.md](https://github.com/ovh/ovhcloud-cli/blob/master/CONTRIBUTING.md)
Have a look in [CONTRIBUTING.md](https://github.com/ovh/ovhcloud-cli/blob/main/CONTRIBUTING.md)
## Build
```sh
# Build the OVHcloud cli
make build
make all
# Cross-compile for other targets in ./dist
make release-snapshot

View file

@ -80,9 +80,9 @@ Below is the full list of primary subcommands available at the time of writin
* [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 baremetal services
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your Bare Metal services
* [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
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [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
@ -95,15 +95,15 @@ Below is the full list of primary subcommands available at the time of writin
* [ovhcloud email-pro](ovhcloud_email-pro.md) - Retrieve information and manage your EmailPro services
* [ovhcloud hosting-private-database](ovhcloud_hosting-private-database.md) - Retrieve information and manage your HostingPrivateDatabase services
* [ovhcloud iam](ovhcloud_iam.md) - Manage IAM resources, permissions and policies
* [ovhcloud ip](ovhcloud_ip.md) - Retrieve information and manage your Ip services
* [ovhcloud iploadbalancing](ovhcloud_iploadbalancing.md) - Retrieve information and manage your IpLoadbalancing services
* [ovhcloud ldp](ovhcloud_ldp.md) - Retrieve information and manage your Ldp services
* [ovhcloud ip](ovhcloud_ip.md) - Retrieve information and manage your IP services
* [ovhcloud iploadbalancing](ovhcloud_iploadbalancing.md) - Retrieve information and manage your IP LoadBalancing services
* [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 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
* [ovhcloud ovhcloudconnect](ovhcloud_ovhcloudconnect.md) - Retrieve information and manage your OvhCloudConnect services
* [ovhcloud ovhcloudconnect](ovhcloud_ovhcloudconnect.md) - Retrieve information and manage your OVHcloud Connect services
* [ovhcloud pack-xdsl](ovhcloud_pack-xdsl.md) - Retrieve information and manage your PackXDSL services
* [ovhcloud sms](ovhcloud_sms.md) - Retrieve information and manage your SMS services
* [ovhcloud ssl](ovhcloud_ssl.md) - Retrieve information and manage your SSL services
@ -114,8 +114,8 @@ Below is the full list of primary subcommands available at the time of writin
* [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
* [ovhcloud vmwareclouddirector-backup](ovhcloud_vmwareclouddirector-backup.md) - Retrieve information and manage your VmwareCloudDirectorBackup services
* [ovhcloud vmwareclouddirector-organization](ovhcloud_vmwareclouddirector-organization.md) - Retrieve information and manage your VmwareCloudDirector Organizations
* [ovhcloud vmwareclouddirector-backup](ovhcloud_vmwareclouddirector-backup.md) - Retrieve information and manage your VMware Cloud Director Backup services
* [ovhcloud vmwareclouddirector-organization](ovhcloud_vmwareclouddirector-organization.md) - Retrieve information and manage your VMware Cloud Director Organizations
* [ovhcloud vps](ovhcloud_vps.md) - Retrieve information and manage your VPS services
* [ovhcloud vrack](ovhcloud_vrack.md) - Retrieve information and manage your vRack services
* [ovhcloud vrackservices](ovhcloud_vrackservices.md) - Retrieve information and manage your vRackServices services

View file

@ -30,5 +30,6 @@ Manage your account
* [ovhcloud](ovhcloud.md) - CLI to manage your OVHcloud services
* [ovhcloud account api](ovhcloud_account_api.md) - Manage your API credentials
* [ovhcloud account get](ovhcloud_account_get.md) - Retrieve basic personal information
* [ovhcloud account ssh-key](ovhcloud_account_ssh-key.md) - Manage your SSH keys

View file

@ -1,12 +1,15 @@
## ovhcloud cloud loadbalancer
## ovhcloud account get
Manage loadbalancers in the given cloud project
Retrieve basic personal information
```
ovhcloud account get [flags]
```
### Options
```
--cloud-project string Cloud project ID
-h, --help help for loadbalancer
-h, --help help for get
```
### Options inherited from parent commands
@ -29,8 +32,5 @@ Manage loadbalancers in the given cloud project
### SEE ALSO
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe
* [ovhcloud cloud loadbalancer edit](ovhcloud_cloud_loadbalancer_edit.md) - Edit the given loadbalancer
* [ovhcloud cloud loadbalancer get](ovhcloud_cloud_loadbalancer_get.md) - Get a specific loadbalancer
* [ovhcloud cloud loadbalancer list](ovhcloud_cloud_loadbalancer_list.md) - List your loadbalancers
* [ovhcloud account](ovhcloud_account.md) - Manage your account

View file

@ -1,6 +1,6 @@
## ovhcloud baremetal
Retrieve information and manage your baremetal services
Retrieve information and manage your Bare Metal services
### Options

View file

@ -28,7 +28,7 @@ Manage boot options for the given baremetal
### SEE ALSO
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your baremetal services
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your Bare Metal services
* [ovhcloud baremetal boot list](ovhcloud_baremetal_boot_list.md) - List boot options for the given baremetal
* [ovhcloud baremetal boot set](ovhcloud_baremetal_boot_set.md) - Configure a boot ID on the given baremetal
* [ovhcloud baremetal boot set-script](ovhcloud_baremetal_boot_set-script.md) - Configure a boot script on the given baremetal

View file

@ -42,5 +42,5 @@ ovhcloud baremetal edit <service_name> [flags]
### SEE ALSO
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your baremetal services
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your Bare Metal services

View file

@ -32,5 +32,5 @@ ovhcloud baremetal get <service_name> [flags]
### SEE ALSO
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your baremetal services
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your Bare Metal services

View file

@ -28,6 +28,6 @@ Manage IPMI on your baremetal
### SEE ALSO
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your baremetal services
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your Bare Metal services
* [ovhcloud baremetal ipmi get-access](ovhcloud_baremetal_ipmi_get-access.md) - Request an acces on KVM IPMI interface

View file

@ -39,5 +39,5 @@ ovhcloud baremetal list-compatible-os <service_name> [flags]
### SEE ALSO
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your baremetal services
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your Bare Metal services

View file

@ -39,5 +39,5 @@ ovhcloud baremetal list-interventions <service_name> [flags]
### SEE ALSO
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your baremetal services
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your Bare Metal services

View file

@ -39,5 +39,5 @@ ovhcloud baremetal list-ips <service_name> [flags]
### SEE ALSO
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your baremetal services
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your Bare Metal services

View file

@ -39,5 +39,5 @@ ovhcloud baremetal list-secrets <service_name> [flags]
### SEE ALSO
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your baremetal services
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your Bare Metal services

View file

@ -39,5 +39,5 @@ ovhcloud baremetal list-tasks <service_name> [flags]
### SEE ALSO
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your baremetal services
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your Bare Metal services

View file

@ -39,5 +39,5 @@ ovhcloud baremetal list [flags]
### SEE ALSO
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your baremetal services
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your Bare Metal services

View file

@ -33,5 +33,5 @@ ovhcloud baremetal reboot-rescue <service_name> [flags]
### SEE ALSO
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your baremetal services
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your Bare Metal services

View file

@ -32,5 +32,5 @@ ovhcloud baremetal reboot <service_name> [flags]
### SEE ALSO
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your baremetal services
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your Bare Metal services

View file

@ -95,5 +95,5 @@ ovhcloud baremetal reinstall <service_name> [flags]
### SEE ALSO
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your baremetal services
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your Bare Metal services

View file

@ -28,7 +28,7 @@ Manage Virtual Network Interfaces of the given baremetal
### SEE ALSO
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your baremetal services
* [ovhcloud baremetal](ovhcloud_baremetal.md) - Retrieve information and manage your Bare Metal services
* [ovhcloud baremetal vni list](ovhcloud_baremetal_vni_list.md) - List Virtual Network Interfaces of the given baremetal
* [ovhcloud baremetal vni ola-create-aggregation](ovhcloud_baremetal_vni_ola-create-aggregation.md) - Group interfaces into an aggregation
* [ovhcloud baremetal vni ola-reset](ovhcloud_baremetal_vni_ola-reset.md) - Reset interfaces to default configuration

View file

@ -1,6 +1,6 @@
## ovhcloud cloud
Manage your projects and services in the Public Cloud universe
Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
### Options
@ -33,7 +33,6 @@ Manage your projects and services in the Public Cloud universe
* [ovhcloud cloud database-service](ovhcloud_cloud_database-service.md) - Manage database services in the given cloud project
* [ovhcloud cloud instance](ovhcloud_cloud_instance.md) - Manage instances in the given cloud project
* [ovhcloud cloud kube](ovhcloud_cloud_kube.md) - Manage Kubernetes clusters in the given cloud project
* [ovhcloud cloud loadbalancer](ovhcloud_cloud_loadbalancer.md) - Manage loadbalancers in the given cloud project
* [ovhcloud cloud network](ovhcloud_cloud_network.md) - Manage networks in the given cloud project
* [ovhcloud cloud operation](ovhcloud_cloud_operation.md) - List and get operations in the given cloud project
* [ovhcloud cloud project](ovhcloud_cloud_project.md) - Retrieve information and manage your CloudProject services

View file

@ -29,7 +29,7 @@ Manage container registries in the given cloud project
### SEE ALSO
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud cloud container-registry create](ovhcloud_cloud_container-registry_create.md) - Create a new container registry
* [ovhcloud cloud container-registry delete](ovhcloud_cloud_container-registry_delete.md) - Delete a specific container registry
* [ovhcloud cloud container-registry edit](ovhcloud_cloud_container-registry_edit.md) - Edit the given container registry

View file

@ -29,11 +29,11 @@ Manage database services in the given cloud project
### SEE ALSO
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud cloud database-service create](ovhcloud_cloud_database-service_create.md) - Create a new database service
* [ovhcloud cloud database-service database](ovhcloud_cloud_database-service_database.md) - Manage databases in a specific database service
* [ovhcloud cloud database-service delete](ovhcloud_cloud_database-service_delete.md) - Delete a specific database service
* [ovhcloud cloud database-service edit](ovhcloud_cloud_database-service_edit.md) - Edit a specific database service
* [ovhcloud cloud database-service get](ovhcloud_cloud_database-service_get.md) - Get a specific database services
* [ovhcloud cloud database-service get](ovhcloud_cloud_database-service_get.md) - Get a specific database service
* [ovhcloud cloud database-service list](ovhcloud_cloud_database-service_list.md) - List your database services

View file

@ -1,6 +1,6 @@
## ovhcloud cloud database-service get
Get a specific database services
Get a specific database service
```
ovhcloud cloud database-service get <cluster_id> [flags]

View file

@ -29,7 +29,7 @@ Manage instances in the given cloud project
### SEE ALSO
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud cloud instance activate-monthly-billing](ovhcloud_cloud_instance_activate-monthly-billing.md) - Activate monthly billing for the given instance
* [ovhcloud cloud instance create](ovhcloud_cloud_instance_create.md) - Create a new instance
* [ovhcloud cloud instance delete](ovhcloud_cloud_instance_delete.md) - Delete the given instance

View file

@ -61,7 +61,7 @@ ovhcloud cloud instance create <region (e.g. GRA9, BHS5, SBG3)> [flags]
--backup-cron string Autobackup Unix Cron pattern (eg: '0 0 * * *')
--backup-rotation int Number of backups to keep
--billing-period string Billing period (hourly, monthly), default is hourly (default "hourly")
--boot-from.image string Image ID to boot from (you can use 'ovhcloud cloud reference list-images' to get the image ID)
--boot-from.image string Image ID to boot from (you can use 'ovhcloud cloud reference list-images' to get the image ID or 'ovhcloud cloud instance snapshot ls' to get the snapshots)
--boot-from.volume string Volume ID to boot from
--bulk int Number of instances to create
--editor Use a text editor to define parameters

View file

@ -32,4 +32,7 @@ Manage snapshots of the given instance
* [ovhcloud cloud instance](ovhcloud_cloud_instance.md) - Manage instances in the given cloud project
* [ovhcloud cloud instance snapshot abort](ovhcloud_cloud_instance_snapshot_abort.md) - Abort the snapshot creation of the given instance
* [ovhcloud cloud instance snapshot create](ovhcloud_cloud_instance_snapshot_create.md) - Create a snapshot of the given instance
* [ovhcloud cloud instance snapshot delete](ovhcloud_cloud_instance_snapshot_delete.md) - Delete a specific instance snapshot in the current cloud project
* [ovhcloud cloud instance snapshot get](ovhcloud_cloud_instance_snapshot_get.md) - Get a specific instance snapshot in the current cloud project
* [ovhcloud cloud instance snapshot list](ovhcloud_cloud_instance_snapshot_list.md) - List all instance snapshots in the current cloud project

View file

@ -9,7 +9,9 @@ ovhcloud cloud instance snapshot create <instance_id> <snapshot_name> [flags]
### Options
```
-h, --help help for create
--distant-region-name string Name of the distant region (for cross region snapshot)
--distant-snapshot-name string Name of the snapshot in the distant region (for cross region snapshot)
-h, --help help for create
```
### Options inherited from parent commands

View file

@ -0,0 +1,37 @@
## ovhcloud cloud instance snapshot delete
Delete a specific instance snapshot in the current cloud project
```
ovhcloud cloud instance snapshot delete <snapshot_id> [flags]
```
### Options
```
-h, --help help for delete
```
### Options inherited from parent commands
```
--cloud-project string Cloud project ID
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud cloud instance snapshot](ovhcloud_cloud_instance_snapshot.md) - Manage snapshots of the given instance

View file

@ -0,0 +1,37 @@
## ovhcloud cloud instance snapshot get
Get a specific instance snapshot in the current cloud project
```
ovhcloud cloud instance snapshot get <snapshot_id> [flags]
```
### Options
```
-h, --help help for get
```
### Options inherited from parent commands
```
--cloud-project string Cloud project ID
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud cloud instance snapshot](ovhcloud_cloud_instance_snapshot.md) - Manage snapshots of the given instance

View file

@ -0,0 +1,44 @@
## ovhcloud cloud instance snapshot list
List all instance snapshots in the current cloud project
```
ovhcloud cloud instance snapshot list [flags]
```
### Options
```
--filter stringArray Filter results by any property using https://github.com/PaesslerAG/gval syntax
Examples:
--filter 'state="running"'
--filter 'name=~"^my.*"'
--filter 'nested.property.subproperty>10'
--filter 'startDate>="2023-12-01"'
--filter 'name=~"something" && nbField>10'
-h, --help help for list
```
### Options inherited from parent commands
```
--cloud-project string Cloud project ID
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud cloud instance snapshot](ovhcloud_cloud_instance_snapshot.md) - Manage snapshots of the given instance

View file

@ -29,7 +29,7 @@ Manage Kubernetes clusters in the given cloud project
### SEE ALSO
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud cloud kube create](ovhcloud_cloud_kube_create.md) - Create a new Kubernetes cluster
* [ovhcloud cloud kube customization](ovhcloud_cloud_kube_customization.md) - Manage Kubernetes cluster customizations
* [ovhcloud cloud kube delete](ovhcloud_cloud_kube_delete.md) - Delete the given Kubernetes cluster

View file

@ -58,8 +58,9 @@ ovhcloud cloud kube nodepool create <cluster_id> [flags]
```
--anti-affinity Enable anti-affinity for the node pool
--attach-floating-ips Enable FloatingIP creation, if true, a floating IP will be created and attached to each node
--autoscale Enable autoscaling for the node pool
--availability-zones strings Availability zones for the node pool
--availability-zones stringArray Availability zones for the node pool
--desired-nodes int Desired number of nodes
--editor Use a text editor to define parameters
--flavor-name string Flavor name for the nodes (b2-7, b2-15, etc.)

View file

@ -9,6 +9,7 @@ ovhcloud cloud kube nodepool edit <cluster_id> <nodepool_id> [flags]
### Options
```
--attach-floating-ips Enable FloatingIP creation, if true, a floating IP will be created and attached to each node
--autoscale Enable autoscaling for the node pool
--desired-nodes int Desired number of nodes
--editor Use a text editor to define parameters

View file

@ -29,8 +29,9 @@ Manage networks in the given cloud project
### SEE ALSO
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud cloud network gateway](ovhcloud_cloud_network_gateway.md) - Manage gateways in the given cloud project
* [ovhcloud cloud network loadbalancer](ovhcloud_cloud_network_loadbalancer.md) - Manage loadbalancers in the given cloud project
* [ovhcloud cloud network private](ovhcloud_cloud_network_private.md) - Manage private networks in the given cloud project
* [ovhcloud cloud network public](ovhcloud_cloud_network_public.md) - Manage public networks in the given cloud project

View file

@ -0,0 +1,36 @@
## ovhcloud cloud network loadbalancer
Manage loadbalancers in the given cloud project
### Options
```
-h, --help help for loadbalancer
```
### Options inherited from parent commands
```
--cloud-project string Cloud project ID
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud cloud network](ovhcloud_cloud_network.md) - Manage networks in the given cloud project
* [ovhcloud cloud network loadbalancer edit](ovhcloud_cloud_network_loadbalancer_edit.md) - Edit the given loadbalancer
* [ovhcloud cloud network loadbalancer get](ovhcloud_cloud_network_loadbalancer_get.md) - Get a specific loadbalancer
* [ovhcloud cloud network loadbalancer list](ovhcloud_cloud_network_loadbalancer_list.md) - List your loadbalancers

View file

@ -1,9 +1,9 @@
## ovhcloud cloud loadbalancer edit
## ovhcloud cloud network loadbalancer edit
Edit the given loadbalancer
```
ovhcloud cloud loadbalancer edit <loadbalancer_id> [flags]
ovhcloud cloud network loadbalancer edit <loadbalancer_id> [flags]
```
### Options
@ -11,9 +11,9 @@ ovhcloud cloud loadbalancer edit <loadbalancer_id> [flags]
```
--description string Description of the loadbalancer
--editor Use a text editor to define parameters
--flavor string Flavor ID of the loadbalancer (can be retrieved with 'cloud reference loadbalancer list-flavors <region>')
-h, --help help for edit
--name string Name of the loadbalancer
--size string Size of the load balancer (S, M, L)
```
### Options inherited from parent commands
@ -37,5 +37,5 @@ ovhcloud cloud loadbalancer edit <loadbalancer_id> [flags]
### SEE ALSO
* [ovhcloud cloud loadbalancer](ovhcloud_cloud_loadbalancer.md) - Manage loadbalancers in the given cloud project
* [ovhcloud cloud network loadbalancer](ovhcloud_cloud_network_loadbalancer.md) - Manage loadbalancers in the given cloud project

View file

@ -1,9 +1,9 @@
## ovhcloud cloud loadbalancer get
## ovhcloud cloud network loadbalancer get
Get a specific loadbalancer
```
ovhcloud cloud loadbalancer get <loadbalancer_id> [flags]
ovhcloud cloud network loadbalancer get <loadbalancer_id> [flags]
```
### Options
@ -33,5 +33,5 @@ ovhcloud cloud loadbalancer get <loadbalancer_id> [flags]
### SEE ALSO
* [ovhcloud cloud loadbalancer](ovhcloud_cloud_loadbalancer.md) - Manage loadbalancers in the given cloud project
* [ovhcloud cloud network loadbalancer](ovhcloud_cloud_network_loadbalancer.md) - Manage loadbalancers in the given cloud project

View file

@ -1,9 +1,9 @@
## ovhcloud cloud loadbalancer list
## ovhcloud cloud network loadbalancer list
List your loadbalancers
```
ovhcloud cloud loadbalancer list [flags]
ovhcloud cloud network loadbalancer list [flags]
```
### Options
@ -40,5 +40,5 @@ ovhcloud cloud loadbalancer list [flags]
### SEE ALSO
* [ovhcloud cloud loadbalancer](ovhcloud_cloud_loadbalancer.md) - Manage loadbalancers in the given cloud project
* [ovhcloud cloud network loadbalancer](ovhcloud_cloud_network_loadbalancer.md) - Manage loadbalancers in the given cloud project

View file

@ -30,6 +30,7 @@ Manage subnets in a specific private network
### SEE ALSO
* [ovhcloud cloud network private](ovhcloud_cloud_network_private.md) - Manage private networks in the given cloud project
* [ovhcloud cloud network private subnet create](ovhcloud_cloud_network_private_subnet_create.md) - Create a subnet in the given private network
* [ovhcloud cloud network private subnet delete](ovhcloud_cloud_network_private_subnet_delete.md) - Delete a specific subnet in a private network
* [ovhcloud cloud network private subnet edit](ovhcloud_cloud_network_private_subnet_edit.md) - Edit a specific subnet in a private network
* [ovhcloud cloud network private subnet get](ovhcloud_cloud_network_private_subnet_get.md) - Get a specific subnet in a private network

View file

@ -0,0 +1,87 @@
## ovhcloud cloud network private subnet create
Create a subnet in the given private network
### Synopsis
Use this command to create a new subnet in a private network.
There are three ways to define the parameters:
1. Using only CLI flags:
ovhcloud cloud network private subnet create <network_id> --network 192.168.1.0/24 --start 192.168.1.12 --end 192.168.1.24 --region GRA9
2. Using a configuration file:
First you can generate an example of parameters file using the following command:
ovhcloud cloud network private subnet create <network_id> --init-file ./params.json
You will be able to choose from several examples of parameters. Once an example has been selected, the content is written in the given file.
After editing the file to set the correct creation parameters, run:
ovhcloud cloud network private subnet create <network_id> --from-file ./params.json
Note that you can also pipe the content of the parameters file, like the following:
cat ./params.json | ovhcloud cloud network private subnet create <network_id>
In both cases, you can override the parameters in the given file using command line flags, for example:
ovhcloud cloud network private subnet create <network_id> --from-file ./params.json --region BHS5
3. Using your default text editor:
ovhcloud cloud network private subnet create <network_id> --editor
You will be able to choose from several examples of parameters. Once an example has been selected, the CLI will open your
default text editor to update the parameters. When saving the file, the creation will start.
Note that it is also possible to override values in the presented examples using command line flags like the following:
ovhcloud cloud network private subnet create <network_id> --editor --region DE1
```
ovhcloud cloud network private subnet create <network_id> [flags]
```
### Options
```
--dhcp Enable DHCP for the subnet
--editor Use a text editor to define parameters
--end string Last IP for this region (eg: 192.168.1.24)
--from-file string File containing parameters
-h, --help help for create
--init-file string Create a file with example parameters
--network string Global network CIDR (eg: 192.168.1.0/24)
--no-gateway Use this flag if you don't want to set a default gateway IP
--region string Region for the subnet
--replace Replace parameters file if it already exists
--start string First IP for this region (eg: 192.168.1.12)
```
### Options inherited from parent commands
```
--cloud-project string Cloud project ID
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud cloud network private subnet](ovhcloud_cloud_network_private_subnet.md) - Manage subnets in a specific private network

View file

@ -29,7 +29,7 @@ List and get operations in the given cloud project
### SEE ALSO
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud cloud operation get](ovhcloud_cloud_operation_get.md) - Get a specific operation
* [ovhcloud cloud operation list](ovhcloud_cloud_operation_list.md) - List operations of the given project

View file

@ -28,7 +28,7 @@ Retrieve information and manage your CloudProject services
### SEE ALSO
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud cloud project edit](ovhcloud_cloud_project_edit.md) - Edit the given cloud project
* [ovhcloud cloud project get](ovhcloud_cloud_project_get.md) - Retrieve information of a specific cloud project
* [ovhcloud cloud project list](ovhcloud_cloud_project_list.md) - List your cloud projects

View file

@ -29,6 +29,6 @@ Check quotas in the given cloud project
### SEE ALSO
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud cloud quota get](ovhcloud_cloud_quota_get.md) - Get quotas for a specific region

View file

@ -29,10 +29,11 @@ Manage Rancher services in the given cloud project
### SEE ALSO
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud cloud rancher create](ovhcloud_cloud_rancher_create.md) - Create a new Rancher service
* [ovhcloud cloud rancher delete](ovhcloud_cloud_rancher_delete.md) - Delete a specific Rancher service
* [ovhcloud cloud rancher edit](ovhcloud_cloud_rancher_edit.md) - Edit the given Rancher service
* [ovhcloud cloud rancher get](ovhcloud_cloud_rancher_get.md) - Get a specific Rancher service
* [ovhcloud cloud rancher list](ovhcloud_cloud_rancher_list.md) - List Rancher services
* [ovhcloud cloud rancher reset-admin-credentials](ovhcloud_cloud_rancher_reset-admin-credentials.md) - Reset admin user credentials

View file

@ -9,12 +9,12 @@ ovhcloud cloud rancher edit <rancher_id> [flags]
### Options
```
--editor Use a text editor to define parameters
-h, --help help for edit
--ip-restrictions stringArray List of IP restrictions (expected format: '<cidrBlock>,<description>')
--name string Name of the managed Rancher service
--plan string Plan of the managed Rancher service (OVHCLOUD_EDITION, STANDARD)
--version string Version of the managed Rancher service
--editor Use a text editor to define parameters
-h, --help help for edit
--iam-auth-enabled Allow Rancher to use identities managed by OVHcloud IAM (Identity and Access Management) to control access
--name string Name of the managed Rancher service
--plan string Plan of the managed Rancher service (OVHCLOUD_EDITION, STANDARD)
--version string Version of the managed Rancher service
```
### Options inherited from parent commands

View file

@ -0,0 +1,37 @@
## ovhcloud cloud rancher reset-admin-credentials
Reset admin user credentials
```
ovhcloud cloud rancher reset-admin-credentials <rancher_id> [flags]
```
### Options
```
-h, --help help for reset-admin-credentials
```
### Options inherited from parent commands
```
--cloud-project string Cloud project ID
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud cloud rancher](ovhcloud_cloud_rancher.md) - Manage Rancher services in the given cloud project

View file

@ -29,10 +29,11 @@ Fetch reference data in the given cloud project
### SEE ALSO
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud cloud reference container-registry](ovhcloud_cloud_reference_container-registry.md) - Fetch container registry reference data in the given cloud project
* [ovhcloud cloud reference database](ovhcloud_cloud_reference_database.md) - Fetch database reference data in the given cloud project
* [ovhcloud cloud reference list-flavors](ovhcloud_cloud_reference_list-flavors.md) - List available flavors in the given cloud project
* [ovhcloud cloud reference list-images](ovhcloud_cloud_reference_list-images.md) - List available images in the given cloud project
* [ovhcloud cloud reference loadbalancer](ovhcloud_cloud_reference_loadbalancer.md) - Fetch loadbalancer reference data in the given cloud project
* [ovhcloud cloud reference rancher](ovhcloud_cloud_reference_rancher.md) - Fetch Rancher reference data in the given cloud project

View file

@ -0,0 +1,34 @@
## ovhcloud cloud reference loadbalancer
Fetch loadbalancer reference data in the given cloud project
### Options
```
-h, --help help for loadbalancer
```
### Options inherited from parent commands
```
--cloud-project string Cloud project ID
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud cloud reference](ovhcloud_cloud_reference.md) - Fetch reference data in the given cloud project
* [ovhcloud cloud reference loadbalancer list-flavors](ovhcloud_cloud_reference_loadbalancer_list-flavors.md) - List available loadbalancer flavors in the given cloud project

View file

@ -0,0 +1,44 @@
## ovhcloud cloud reference loadbalancer list-flavors
List available loadbalancer flavors in the given cloud project
```
ovhcloud cloud reference loadbalancer list-flavors <region (GRA9, BHS5, ...)> [flags]
```
### Options
```
--filter stringArray Filter results by any property using https://github.com/PaesslerAG/gval syntax
Examples:
--filter 'state="running"'
--filter 'name=~"^my.*"'
--filter 'nested.property.subproperty>10'
--filter 'startDate>="2023-12-01"'
--filter 'name=~"something" && nbField>10'
-h, --help help for list-flavors
```
### Options inherited from parent commands
```
--cloud-project string Cloud project ID
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud cloud reference loadbalancer](ovhcloud_cloud_reference_loadbalancer.md) - Fetch loadbalancer reference data in the given cloud project

View file

@ -29,7 +29,7 @@ Check regions in the given cloud project
### SEE ALSO
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud cloud region get](ovhcloud_cloud_region_get.md) - Get information about a region
* [ovhcloud cloud region list](ovhcloud_cloud_region_list.md) - List regions

View file

@ -29,7 +29,7 @@ Manage SSH keys in the given cloud project
### SEE ALSO
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud cloud ssh-key get](ovhcloud_cloud_ssh-key_get.md) - Get information about a SSH key
* [ovhcloud cloud ssh-key list](ovhcloud_cloud_ssh-key_list.md) - List SSH keys

View file

@ -29,7 +29,7 @@ Manage block storage volumes in the given cloud project
### SEE ALSO
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud cloud storage-block attach](ovhcloud_cloud_storage-block_attach.md) - Attach the given volume to the given instance
* [ovhcloud cloud storage-block backup](ovhcloud_cloud_storage-block_backup.md) - Manage volume backups in the given cloud project
* [ovhcloud cloud storage-block create](ovhcloud_cloud_storage-block_create.md) - Create a new volume

View file

@ -29,7 +29,7 @@ Manage S3™* compatible storage containers in the given cloud project (* S3 is
### SEE ALSO
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud cloud storage-s3 add-user](ovhcloud_cloud_storage-s3_add-user.md) - Add a user to the given storage container with the specified role (admin, deny, readOnly, readWrite)
* [ovhcloud cloud storage-s3 bulk-delete](ovhcloud_cloud_storage-s3_bulk-delete.md) - Bulk delete objects in the given storage container
* [ovhcloud cloud storage-s3 create](ovhcloud_cloud_storage-s3_create.md) - Create a new S3™* compatible storage container (* S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc.)

View file

@ -3,14 +3,16 @@
Bulk delete objects in the given storage container
```
ovhcloud cloud storage-s3 bulk-delete [flags]
ovhcloud cloud storage-s3 bulk-delete <container_name> [flags]
```
### Options
```
--all Delete all objects in the container
-h, --help help for bulk-delete
--objects strings List of objects to delete (format is '<object_name>' or '<object_name>:<version_id>'
--prefix string Prefix to filter objects to delete
```
### Options inherited from parent commands

View file

@ -29,7 +29,7 @@ Manage SWIFT storage containers in the given cloud project
### SEE ALSO
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud cloud storage-swift edit](ovhcloud_cloud_storage-swift_edit.md) - Edit the given SWIFT storage container
* [ovhcloud cloud storage-swift get](ovhcloud_cloud_storage-swift_get.md) - Get a specific SWIFT storage container
* [ovhcloud cloud storage-swift list](ovhcloud_cloud_storage-swift_list.md) - List SWIFT storage containers

View file

@ -29,7 +29,7 @@ Manage users in the given cloud project
### SEE ALSO
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe
* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud cloud user create](ovhcloud_cloud_user_create.md) - Create a new user
* [ovhcloud cloud user delete](ovhcloud_cloud_user_delete.md) - Delete the given user
* [ovhcloud cloud user get](ovhcloud_cloud_user_get.md) - Get information about a user

View file

@ -31,4 +31,6 @@ Retrieve information and manage your domain zones
* [ovhcloud](ovhcloud.md) - CLI to manage your OVHcloud services
* [ovhcloud domain-zone get](ovhcloud_domain-zone_get.md) - Retrieve information of a specific domain zone
* [ovhcloud domain-zone list](ovhcloud_domain-zone_list.md) - List your domain zones
* [ovhcloud domain-zone record](ovhcloud_domain-zone_record.md) - Retrieve information and manage your DNS records within a zone
* [ovhcloud domain-zone refresh](ovhcloud_domain-zone_refresh.md) - Refresh the given zone

View file

@ -0,0 +1,36 @@
## ovhcloud domain-zone record
Retrieve information and manage your DNS records within a zone
### Options
```
-h, --help help for record
```
### Options inherited from parent commands
```
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud domain-zone](ovhcloud_domain-zone.md) - Retrieve information and manage your domain zones
* [ovhcloud domain-zone record create](ovhcloud_domain-zone_record_create.md) - Create a single DNS record in your zone
* [ovhcloud domain-zone record delete](ovhcloud_domain-zone_record_delete.md) - Delete a single DNS record from your zone
* [ovhcloud domain-zone record get](ovhcloud_domain-zone_record_get.md) - Get a single DNS record from your zone
* [ovhcloud domain-zone record update](ovhcloud_domain-zone_record_update.md) - Update a single DNS record from your zone

View file

@ -0,0 +1,44 @@
## ovhcloud domain-zone record create
Create a single DNS record in your zone
```
ovhcloud domain-zone record create <zone_name> [flags]
```
### Options
```
--editor Use a text editor to define parameters
--field-type string Record type (A, AAAA, CAA, CNAME, DKIM, DMARC, DNAME, HTTPS, LOC, MX, NAPTR, NS, PTR, RP, SPF, SRV, SSHFP, SVCB, TLSA, TXT)
--from-file string File containing parameters
-h, --help help for create
--init-file string Create a file with example parameters
--replace Replace parameters file if it already exists
--sub-domain string Record subDomain
--target string Target of the record
--ttl int TTL of the record
```
### Options inherited from parent commands
```
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud domain-zone record](ovhcloud_domain-zone_record.md) - Retrieve information and manage your DNS records within a zone

View file

@ -0,0 +1,36 @@
## ovhcloud domain-zone record delete
Delete a single DNS record from your zone
```
ovhcloud domain-zone record delete <zone_name> <record_id> [flags]
```
### Options
```
-h, --help help for delete
```
### Options inherited from parent commands
```
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud domain-zone record](ovhcloud_domain-zone_record.md) - Retrieve information and manage your DNS records within a zone

View file

@ -0,0 +1,36 @@
## ovhcloud domain-zone record get
Get a single DNS record from your zone
```
ovhcloud domain-zone record get <zone_name> <record_id> [flags]
```
### Options
```
-h, --help help for get
```
### Options inherited from parent commands
```
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud domain-zone record](ovhcloud_domain-zone_record.md) - Retrieve information and manage your DNS records within a zone

View file

@ -0,0 +1,43 @@
## ovhcloud domain-zone record update
Update a single DNS record from your zone
```
ovhcloud domain-zone record update <zone_name> <record_id> [flags]
```
### Options
```
--editor Use a text editor to define parameters
--from-file string File containing parameters
-h, --help help for update
--init-file string Create a file with example parameters
--replace Replace parameters file if it already exists
--sub-domain string Subdomain to update
--target string New target to apply
--ttl int New TTL to apply
```
### Options inherited from parent commands
```
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud domain-zone record](ovhcloud_domain-zone_record.md) - Retrieve information and manage your DNS records within a zone

View file

@ -0,0 +1,36 @@
## ovhcloud domain-zone refresh
Refresh the given zone
```
ovhcloud domain-zone refresh <zone_name> [flags]
```
### Options
```
-h, --help help for refresh
```
### Options inherited from parent commands
```
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud domain-zone](ovhcloud_domain-zone.md) - Retrieve information and manage your domain zones

View file

@ -33,4 +33,5 @@ Manage IAM resources, permissions and policies
* [ovhcloud iam policy](ovhcloud_iam_policy.md) - Manage IAM policies
* [ovhcloud iam resource](ovhcloud_iam_resource.md) - Manage IAM resources
* [ovhcloud iam resource-group](ovhcloud_iam_resource-group.md) - Manage IAM resource groups
* [ovhcloud iam user](ovhcloud_iam_user.md) - Manage IAM users

View file

@ -29,6 +29,8 @@ Manage IAM policies
### SEE ALSO
* [ovhcloud iam](ovhcloud_iam.md) - Manage IAM resources, permissions and policies
* [ovhcloud iam policy create](ovhcloud_iam_policy_create.md) - Create a new policy
* [ovhcloud iam policy delete](ovhcloud_iam_policy_delete.md) - Delete a specific IAM policy
* [ovhcloud iam policy edit](ovhcloud_iam_policy_edit.md) - Edit specific IAM policy
* [ovhcloud iam policy get](ovhcloud_iam_policy_get.md) - Get a specific IAM policy
* [ovhcloud iam policy list](ovhcloud_iam_policy_list.md) - List IAM policies

View file

@ -0,0 +1,89 @@
## ovhcloud iam policy create
Create a new policy
### Synopsis
Use this command to create a new policy.
There are three ways to define the creation parameters:
1. Using only CLI flags:
ovhcloud iam policy create --name MyPolicy --allow 'domain:apiovh:get' --identity 'urn:v1:eu:identity:account:aa1-ovh' --resource 'urn:v1:eu:resource:domain:*'
2. Using a configuration file:
First you can generate an example of parameters file using the following command:
ovhcloud iam policy create --init-file ./params.json
You will be able to choose from several examples of parameters. Once an example has been selected, the content is written in the given file.
After editing the file to set the correct creation parameters, run:
ovhcloud iam policy create --from-file ./params.json
Note that you can also pipe the content of the parameters file, like the following:
cat ./params.json | ovhcloud iam policy create
In both cases, you can override the parameters in the given file using command line flags, for example:
ovhcloud iam policy create --from-file ./params.json --name MyPolicy --allow 'domain:apiovh:get' --identity 'urn:v1:eu:identity:account:aa1-ovh' --resource 'urn:v1:eu:resource:domain:*'
3. Using your default text editor:
ovhcloud iam policy create --editor
You will be able to choose from several examples of parameters. Once an example has been selected, the CLI will open your
default text editor to update the parameters. When saving the file, the creation will start.
Note that it is also possible to override values in the presented examples using command line flags like the following:
ovhcloud iam policy create --editor --name MyPolicy --allow 'domain:apiovh:get' --identity 'urn:v1:eu:identity:account:aa1-ovh' --resource 'urn:v1:eu:resource:domain:*'
```
ovhcloud iam policy create [flags]
```
### Options
```
--allow strings List of allowed actions
--deny strings List of denied actions
--description string Description of the policy
--editor Use a text editor to define parameters
--except strings List of actions to filter from the allowed list
--expiredAt string Expiration date of the policy (RFC3339 format), after this date it will no longer be applied
--from-file string File containing parameters
-h, --help help for create
--identity strings Identities to which the policy applies
--init-file string Create a file with example parameters
--name string Name of the policy
--permissions-group strings Permissions group URNs
--replace Replace parameters file if it already exists
--resource strings Resource URNs
```
### Options inherited from parent commands
```
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud iam policy](ovhcloud_iam_policy.md) - Manage IAM policies

View file

@ -0,0 +1,36 @@
## ovhcloud iam policy delete
Delete a specific IAM policy
```
ovhcloud iam policy delete <policy_id> [flags]
```
### Options
```
-h, --help help for delete
```
### Options inherited from parent commands
```
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud iam policy](ovhcloud_iam_policy.md) - Manage IAM policies

38
doc/ovhcloud_iam_user.md Normal file
View file

@ -0,0 +1,38 @@
## ovhcloud iam user
Manage IAM users
### Options
```
-h, --help help for user
```
### Options inherited from parent commands
```
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud iam](ovhcloud_iam.md) - Manage IAM resources, permissions and policies
* [ovhcloud iam user create](ovhcloud_iam_user_create.md) - Create a new user
* [ovhcloud iam user delete](ovhcloud_iam_user_delete.md) - Delete a specific IAM user
* [ovhcloud iam user edit](ovhcloud_iam_user_edit.md) - Edit an existing user
* [ovhcloud iam user get](ovhcloud_iam_user_get.md) - Get a specific IAM user
* [ovhcloud iam user list](ovhcloud_iam_user_list.md) - List IAM users
* [ovhcloud iam user token](ovhcloud_iam_user_token.md) - Manage IAM user tokens

View file

@ -0,0 +1,86 @@
## ovhcloud iam user create
Create a new user
### Synopsis
Use this command to create a new IAM user.
There are three ways to define the creation parameters:
1. Using only CLI flags:
ovhcloud iam user create --login my_user --password 'MyStrongPassword123!' --email fake.email@ovhcloud.com
2. Using a configuration file:
First you can generate an example of parameters file using the following command:
ovhcloud iam user create --init-file ./params.json
You will be able to choose from several examples of parameters. Once an example has been selected, the content is written in the given file.
After editing the file to set the correct creation parameters, run:
ovhcloud iam user create --from-file ./params.json
Note that you can also pipe the content of the parameters file, like the following:
cat ./params.json | ovhcloud iam user create
In both cases, you can override the parameters in the given file using command line flags, for example:
ovhcloud iam user create --from-file ./params.json --login nameoverriden
3. Using your default text editor:
ovhcloud iam user create --editor
You will be able to choose from several examples of parameters. Once an example has been selected, the CLI will open your
default text editor to update the parameters. When saving the file, the creation will start.
Note that it is also possible to override values in the presented examples using command line flags like the following:
ovhcloud iam user create --editor --login nameoverriden
```
ovhcloud iam user create [flags]
```
### Options
```
--description string Description of the user
--editor Use a text editor to define parameters
--email string Email of the user
--from-file string File containing parameters
--group string Group of the user
-h, --help help for create
--init-file string Create a file with example parameters
--login string Login of the user
--password string Password of the user
--replace Replace parameters file if it already exists
--type string Type of the user (ROOT, SERVICE, USER)
```
### Options inherited from parent commands
```
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud iam user](ovhcloud_iam_user.md) - Manage IAM users

View file

@ -0,0 +1,36 @@
## ovhcloud iam user delete
Delete a specific IAM user
```
ovhcloud iam user delete <user_login> [flags]
```
### Options
```
-h, --help help for delete
```
### Options inherited from parent commands
```
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud iam user](ovhcloud_iam_user.md) - Manage IAM users

View file

@ -0,0 +1,83 @@
## ovhcloud iam user edit
Edit an existing user
### Synopsis
Use this command to edit an existing IAM user.
There are three ways to define the editing parameters:
1. Using only CLI flags:
ovhcloud iam user edit <user_login> --email fake.email+replaced@ovhcloud.com
2. Using a configuration file:
First you can generate an example of parameters file using the following command:
ovhcloud iam user edit --init-file ./params.json
You will be able to choose from several examples of parameters. Once an example has been selected, the content is written in the given file.
After editing the file to set the correct parameters, run:
ovhcloud iam user edit <user_login> --from-file ./params.json
Note that you can also pipe the content of the parameters file, like the following:
cat ./params.json | ovhcloud iam user edit <user_login>
In both cases, you can override the parameters in the given file using command line flags, for example:
ovhcloud iam user edit <user_login> --from-file ./params.json --email fake.email+overriden@ovhcloud.com
3. Using your default text editor:
ovhcloud iam user edit <user_login> --editor
You will be able to choose from several examples of parameters. Once an example has been selected, the CLI will open your
default text editor to update the parameters. When saving the file, the creation will start.
Note that it is also possible to override values in the presented examples using command line flags like the following:
ovhcloud iam user edit <user_login> --editor --description "New description"
```
ovhcloud iam user edit <user_login> [flags]
```
### Options
```
--description string Description of the user
--editor Use a text editor to define parameters
--email string Email of the user
--from-file string File containing parameters
--group string Group of the user
-h, --help help for edit
--init-file string Create a file with example parameters
--replace Replace parameters file if it already exists
```
### Options inherited from parent commands
```
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud iam user](ovhcloud_iam_user.md) - Manage IAM users

View file

@ -0,0 +1,36 @@
## ovhcloud iam user get
Get a specific IAM user
```
ovhcloud iam user get <user_login> [flags]
```
### Options
```
-h, --help help for get
```
### Options inherited from parent commands
```
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud iam user](ovhcloud_iam_user.md) - Manage IAM users

View file

@ -0,0 +1,43 @@
## ovhcloud iam user list
List IAM users
```
ovhcloud iam user list [flags]
```
### Options
```
--filter stringArray Filter results by any property using https://github.com/PaesslerAG/gval syntax
Examples:
--filter 'state="running"'
--filter 'name=~"^my.*"'
--filter 'nested.property.subproperty>10'
--filter 'startDate>="2023-12-01"'
--filter 'name=~"something" && nbField>10'
-h, --help help for list
```
### Options inherited from parent commands
```
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud iam user](ovhcloud_iam_user.md) - Manage IAM users

View file

@ -0,0 +1,36 @@
## ovhcloud iam user token
Manage IAM user tokens
### Options
```
-h, --help help for token
```
### Options inherited from parent commands
```
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud iam user](ovhcloud_iam_user.md) - Manage IAM users
* [ovhcloud iam user token create](ovhcloud_iam_user_token_create.md) - Create a new token
* [ovhcloud iam user token delete](ovhcloud_iam_user_token_delete.md) - Delete a specific token of an IAM user
* [ovhcloud iam user token get](ovhcloud_iam_user_token_get.md) - Get a specific token of an IAM user
* [ovhcloud iam user token list](ovhcloud_iam_user_token_list.md) - List tokens of a specific IAM user

View file

@ -0,0 +1,84 @@
## ovhcloud iam user token create
Create a new token
### Synopsis
Use this command to create a new token.
There are three ways to define the creation parameters:
1. Using only CLI flags:
ovhcloud iam user token create --name Token --description Desc
2. Using a configuration file:
First you can generate an example of parameters file using the following command:
ovhcloud iam user token create --init-file ./params.json
You will be able to choose from several examples of parameters. Once an example has been selected, the content is written in the given file.
After editing the file to set the correct creation parameters, run:
ovhcloud iam user token create --from-file ./params.json
Note that you can also pipe the content of the parameters file, like the following:
cat ./params.json | ovhcloud iam user token create
In both cases, you can override the parameters in the given file using command line flags, for example:
ovhcloud iam user token create --from-file ./params.json --name Token --description Desc
3. Using your default text editor:
ovhcloud iam user token create --editor
You will be able to choose from several examples of parameters. Once an example has been selected, the CLI will open your
default text editor to update the parameters. When saving the file, the creation will start.
Note that it is also possible to override values in the presented examples using command line flags like the following:
ovhcloud iam user token create --editor --name Token --description Desc
```
ovhcloud iam user token create <user_login> [flags]
```
### Options
```
--description string Description of the token
--editor Use a text editor to define parameters
--expiredAt string Expiration date of the token (RFC3339 format)
--expiresIn int Number of seconds before the token expires
--from-file string File containing parameters
-h, --help help for create
--init-file string Create a file with example parameters
--name string Name of the token
--replace Replace parameters file if it already exists
```
### Options inherited from parent commands
```
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud iam user token](ovhcloud_iam_user_token.md) - Manage IAM user tokens

View file

@ -0,0 +1,36 @@
## ovhcloud iam user token delete
Delete a specific token of an IAM user
```
ovhcloud iam user token delete <user_login> <token_name> [flags]
```
### Options
```
-h, --help help for delete
```
### Options inherited from parent commands
```
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud iam user token](ovhcloud_iam_user_token.md) - Manage IAM user tokens

View file

@ -0,0 +1,36 @@
## ovhcloud iam user token get
Get a specific token of an IAM user
```
ovhcloud iam user token get <user_login> <token_name> [flags]
```
### Options
```
-h, --help help for get
```
### Options inherited from parent commands
```
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud iam user token](ovhcloud_iam_user_token.md) - Manage IAM user tokens

View file

@ -0,0 +1,43 @@
## ovhcloud iam user token list
List tokens of a specific IAM user
```
ovhcloud iam user token list <user_login> [flags]
```
### Options
```
--filter stringArray Filter results by any property using https://github.com/PaesslerAG/gval syntax
Examples:
--filter 'state="running"'
--filter 'name=~"^my.*"'
--filter 'nested.property.subproperty>10'
--filter 'startDate>="2023-12-01"'
--filter 'name=~"something" && nbField>10'
-h, --help help for list
```
### Options inherited from parent commands
```
-d, --debug Activate debug mode (will log all HTTP requests details)
-f, --format string Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
Examples:
--format 'id' (to extract a single field)
--format 'nested.field.subfield' (to extract a nested field)
--format '[id, 'name']' (to extract multiple fields as an array)
--format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--format 'name+","+type' (to extract and concatenate fields in a string)
--format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-i, --interactive Interactive output
-j, --json Output in JSON
-y, --yaml Output in YAML
```
### SEE ALSO
* [ovhcloud iam user token](ovhcloud_iam_user_token.md) - Manage IAM user tokens

View file

@ -1,6 +1,6 @@
## ovhcloud ip
Retrieve information and manage your Ip services
Retrieve information and manage your IP services
### Options

View file

@ -34,5 +34,5 @@ ovhcloud ip edit <service_name> [flags]
### SEE ALSO
* [ovhcloud ip](ovhcloud_ip.md) - Retrieve information and manage your Ip services
* [ovhcloud ip](ovhcloud_ip.md) - Retrieve information and manage your IP services

View file

@ -32,5 +32,5 @@ ovhcloud ip get <service_name> [flags]
### SEE ALSO
* [ovhcloud ip](ovhcloud_ip.md) - Retrieve information and manage your Ip services
* [ovhcloud ip](ovhcloud_ip.md) - Retrieve information and manage your IP services

View file

@ -39,5 +39,5 @@ ovhcloud ip list [flags]
### SEE ALSO
* [ovhcloud ip](ovhcloud_ip.md) - Retrieve information and manage your Ip services
* [ovhcloud ip](ovhcloud_ip.md) - Retrieve information and manage your IP services

View file

@ -28,7 +28,7 @@ Manage reverses on the given IP
### SEE ALSO
* [ovhcloud ip](ovhcloud_ip.md) - Retrieve information and manage your Ip services
* [ovhcloud ip](ovhcloud_ip.md) - Retrieve information and manage your IP services
* [ovhcloud ip reverse delete](ovhcloud_ip_reverse_delete.md) - Delete reverse on the given IP
* [ovhcloud ip reverse get](ovhcloud_ip_reverse_get.md) - List reverse on the given IP range
* [ovhcloud ip reverse set](ovhcloud_ip_reverse_set.md) - Set reverse on the given IP

View file

@ -1,6 +1,6 @@
## ovhcloud iploadbalancing
Retrieve information and manage your IpLoadbalancing services
Retrieve information and manage your IP LoadBalancing services
### Options

View file

@ -35,5 +35,5 @@ ovhcloud iploadbalancing edit <service_name> [flags]
### SEE ALSO
* [ovhcloud iploadbalancing](ovhcloud_iploadbalancing.md) - Retrieve information and manage your IpLoadbalancing services
* [ovhcloud iploadbalancing](ovhcloud_iploadbalancing.md) - Retrieve information and manage your IP LoadBalancing services

View file

@ -32,5 +32,5 @@ ovhcloud iploadbalancing get <service_name> [flags]
### SEE ALSO
* [ovhcloud iploadbalancing](ovhcloud_iploadbalancing.md) - Retrieve information and manage your IpLoadbalancing services
* [ovhcloud iploadbalancing](ovhcloud_iploadbalancing.md) - Retrieve information and manage your IP LoadBalancing services

View file

@ -39,5 +39,5 @@ ovhcloud iploadbalancing list [flags]
### SEE ALSO
* [ovhcloud iploadbalancing](ovhcloud_iploadbalancing.md) - Retrieve information and manage your IpLoadbalancing services
* [ovhcloud iploadbalancing](ovhcloud_iploadbalancing.md) - Retrieve information and manage your IP LoadBalancing services

View file

@ -1,6 +1,6 @@
## ovhcloud ldp
Retrieve information and manage your Ldp services
Retrieve information and manage your LDP (Logs Data Platform) services
### Options

View file

@ -35,5 +35,5 @@ ovhcloud ldp edit <service_name> [flags]
### SEE ALSO
* [ovhcloud ldp](ovhcloud_ldp.md) - Retrieve information and manage your Ldp services
* [ovhcloud ldp](ovhcloud_ldp.md) - Retrieve information and manage your LDP (Logs Data Platform) services

View file

@ -32,5 +32,5 @@ ovhcloud ldp get <service_name> [flags]
### SEE ALSO
* [ovhcloud ldp](ovhcloud_ldp.md) - Retrieve information and manage your Ldp services
* [ovhcloud ldp](ovhcloud_ldp.md) - Retrieve information and manage your LDP (Logs Data Platform) services

View file

@ -39,5 +39,5 @@ ovhcloud ldp list [flags]
### SEE ALSO
* [ovhcloud ldp](ovhcloud_ldp.md) - Retrieve information and manage your Ldp services
* [ovhcloud ldp](ovhcloud_ldp.md) - Retrieve information and manage your LDP (Logs Data Platform) services

View file

@ -1,6 +1,6 @@
## ovhcloud ovhcloudconnect
Retrieve information and manage your OvhCloudConnect services
Retrieve information and manage your OVHcloud Connect services
### Options

View file

@ -34,5 +34,5 @@ ovhcloud ovhcloudconnect edit <service_name> [flags]
### SEE ALSO
* [ovhcloud ovhcloudconnect](ovhcloud_ovhcloudconnect.md) - Retrieve information and manage your OvhCloudConnect services
* [ovhcloud ovhcloudconnect](ovhcloud_ovhcloudconnect.md) - Retrieve information and manage your OVHcloud Connect services

View file

@ -32,5 +32,5 @@ ovhcloud ovhcloudconnect get <service_name> [flags]
### SEE ALSO
* [ovhcloud ovhcloudconnect](ovhcloud_ovhcloudconnect.md) - Retrieve information and manage your OvhCloudConnect services
* [ovhcloud ovhcloudconnect](ovhcloud_ovhcloudconnect.md) - Retrieve information and manage your OVHcloud Connect services

View file

@ -39,5 +39,5 @@ ovhcloud ovhcloudconnect list [flags]
### SEE ALSO
* [ovhcloud ovhcloudconnect](ovhcloud_ovhcloudconnect.md) - Retrieve information and manage your OvhCloudConnect services
* [ovhcloud ovhcloudconnect](ovhcloud_ovhcloudconnect.md) - Retrieve information and manage your OVHcloud Connect services

Some files were not shown because too many files have changed in this diff Show more