Skip to main content

OVH Command Line Interface

Project description


OVH Command Line Interface.

$ ovh webhosting config
| #ID     | Environment | Engine version | Container     | Path | Engine | Firewall |
| 1994114 | production  | 5.6            | stable        |      | php    | security |

$ ovh webhosting config:update --engine-version=7.0
[*] The configuration will be updated in a few seconds.

$ ovh webhosting config
| #ID     | Environment | Engine version | Container     | Path | Engine | Firewall |
| 2023413 | production  | 7.0            | stable        |      | php    | security |


The OVH Cli works with Python 2.7+ and Python 3.3+.

The easiest way to get the latest stable release is to grab it from pypi using pip :

$ pip install ovhcli

Or if you are not using a virtualenv :

$ sudo pip install ovhcli

If you want to upgrade it :

$ pip install --upgrade ovhcli

Alternatively, you may get latest development version directly from Git :

$ pip install -e git+

Getting started

The Cli uses the public OVH API to manage the user products. A setup command is provided to help you creating the required tokens :

$ ovh setup init
Welcome to the OVH Cli.

This tool uses the public OVH API to manage your products. In order to
work, 3 tokens that you must generate are required :

- the application key (AK)
- the application secret (AS)
- the consumer key (CK)

What's your context :

    1) You already have the keys (AK, AS and CK)
    2) You just have AK and AS, the CK must be generated
    3) You have no keys

Your choice [1]: 3

[-] Please visit the following link to authenticate you and obtain your keys (AK, AS and CK) :
Press any key to continue ...

Endpoint [ovh-eu]: ovh-eu
Application key: <application key>
Application secret: <application secret>
Consumer key: <consumer key>
[*] Configuration file created.

Commands help

Each command and subcommand provides a --help parameter :

$ ovh webhosting --help
Usage: ovh webhosting [OPTIONS] COMMAND [ARGS]...

  Manage and configure your WebHosting products.

  --help  Show this message and exit.

  config          Display the ovhConfig information.
  config:update   Update the ovhConfig information.
  info            Display information about a service.
  info:countries  Display the service countries.
  info:quota      Display the service quota.
  list            List the services.
  users           List the users of a service.
  users:create    Add a new user to a service.
  users:remove    Remove a user from a service.
  users:show      Information about a user.
  users:update    Update an existing user.

JSON output

By default, the OVH Cli displays the output in a pretty table representation. When it’s possible, a --json parameter is provided to return the content as pure JSON :

$ ovh webhosting users --full
| Login       | Home | State | Ssh    | Primary account |
| johndoe     | .    | rw    | active | True            |
| johndoe-foo | foo  | rw    | none   | False           |

$ ovh webhosting users --full --json
[{"iisRemoteRights": null, "sshState": "none", "webDavRights": null, "login": "johndoe-foo", "isPrimaryAccount": false, "state": "rw", "home": "foo"}, {"iisRemoteRights": null, "sshState": "active", "webDavRights": null, "login": "johndoe", "isPrimaryAccount": true, "state": "rw", "home": "."}]


See CONTRIBUTING.rst for contribution guidelines.


3-Clause BSD

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ovhcli-0.0.1.tar.gz (19.4 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page