Installing OSC CLI
To install OSC CLI from the official PyPI package, launch the following command in your terminal:
Update your PATH environment variable:
Configuring OSC CLI
In your home directory, create a directory named
.osc_sdk, create a file named
config.jsonwith the following content:
If necessary, replace
eu-west-2with the Region of your account.
SECRETKEYwith the access key ID and corresponding secret key of your account.
With Cockpit, you can find your access key ID and corresponding secret key using the following steps:
- Hover over your name.
- Click Personal information & Access keys > Access keys.
- Type your password.
If you do not have access to Cockpit, you can get them using the following steps:
- Save the above file.
Run the following command while replacing
PASSWORDwith the email and password of your OUTSCALE account:
You can now execute API calls using OSC CLI.
Using OSC CLI
To send a request using OSC CLI, specify in your command:
- One of the supported APIs (
apifor the OUTSCALE API, or
- The call you request.
- Any other attribute required by the command.
If you need to pass a numeral string instead of an integer (for example:
"12345678" with the quotes as part of the string), you must wrap your string in additional quotes (