Installing OSC CLI

1. Download the .whl file on the official OSC CLI Git repository.
   
   

2. Launch the following command in your terminal, where FILE is the location of your downloaded .whl file: 

   $> pip3 install FILE

Configuring OSC CLI

1. Create the file ~/.osc_sdk/config.json with the following content: 

   {"default":
       {"access_key": "",
        "secret_key": "",
        "host": "outscale.com",
        "https": true,
        "method": "POST",
        "region_name": "eu-west-2",
        "version": "2018-11-19"
       }
   }

   Leave the access_key and secret_key values empty at this stage.

2. To get your access key ID and corresponding secret key, use the ListAccessKeys command following this syntax: 

   Request Sample

   $> osc-cli icu ListAccessKeys \
     --authentication-method password \
     --login youremail@company.com \
     --password Y0URpAssOrd

   This command contains the following attributes that you need to specify: 

   • authentication-method: For this first call, this attribute must be password.
   • login: The email address of your 3DS OUTSCALE account.
   • password: The password of your 3DS OUTSCALE account.

   The ListAccessKeys command returns several elements, including the following: 

   • accessKeyId: The ID of the access key.
   • secretAccessKey: The secret key corresponding to the access key.
     
     
3. Insert the values of your access key ID and corresponding secret key in the config.json file.
   You can now execute any API call using OSC CLI.

Using OSC CLI

To send a request using OSC CLI, specify in your command:

• One of the supported APIs (api for the 3DS OUTSCALE API, or fcu, lbu, eim, icu, directlink or okms).
• The call you request.
• Any other attribute required by the command.

$> osc-cli api CreateVolume \
   --SubregionName eu-west-2a \
   --Size 10