Outscale

https://docs.outscale.com/fr/
Admin
Outscale is a European cloud computing platform providing infrastructure services including virtual...
Tokens:678,671
Snippets:7,701
Trust Score:8
Update:4 months ago
Show doc for...
Tokens:
Raw
### Start Instances Command

Source: https://docs.outscale.com/fr/userguide/Arr%C3%AAter-et-d%C3%A9marrer-des-VM.html

Use this command to start one or more instances. Specify the instance IDs and the appropriate endpoint for your region.

```bash
$ aws ec2 start-instances \
    --profile YOUR_PROFILE \
    --instance-ids i-12345678 \
    --endpoint https://fcu.eu-west-2.outscale.com
```

--------------------------------

### Start Instances Command Output

Source: https://docs.outscale.com/fr/userguide/Arr%C3%AAter-et-d%C3%A9marrer-des-VM.html

This is the expected JSON output when successfully starting instances. It includes details about the instance ID and its state transitions.

```json
{
    "StartingInstances": [
        {
            "InstanceId": "i-12345678",
            "CurrentState": {
                "Code": 0,
                "Name": "pending"
            },
            "PreviousState": {
                "Code": 80,
                "Name": "stopped"
            }
        }
    ]
}
```

--------------------------------

### Create and Activate Python Virtual Environment

Source: https://docs.outscale.com/fr/userguide/Installer-et-configurer-OKS-CLI.html

Recommended for installing OKS CLI and its dependencies to avoid system-wide conflicts. Activate the virtual environment before proceeding with installation.

```shell
python3 -m venv .venv
source .venv/bin/activate
```

--------------------------------

### Example Block Device Mappings

Source: https://docs.outscale.com/fr/userguide/D%C3%A9finir-des-block-device-mappings.html

This example shows how to attach a volume from a snapshot, create a new magnetic volume, and prevent a device from being mapped. This configuration can be used with `run-instances` or `register-image` commands.

```json
[
   {
    "DeviceName": "/dev/xvdb",
    "Ebs": {
            "SnapshotId": "snap-123456789"
           }
    },
   {
    "DeviceName": "/dev/xvdc",
    "Ebs": {
            "VolumeSize": 100,
            "DeleteOnTermination": true
           }
    },
   {
    "DeviceName": "/dev/xvde",
    "NoDevice": ""
   }
]
```

--------------------------------

### Example Project List Output

Source: https://docs.outscale.com/fr/userguide/Lister-vos-projets.html

This is an example of the tabular output format for the `project list` command, showing project name, creation time, update time, status, and default project indicator.

```text
+----------------+----------------+
|      NAME      |    CREATED     |
+----------------+----------------+
|   my-project   |  5 minutes ago |
+----------------+----------------+
```

--------------------------------

### Start a VM using OSC CLI

Source: https://docs.outscale.com/fr/userguide/Arr%C3%AAter-et-d%C3%A9marrer-des-VM.html

Starts one or more virtual machines. Use the `VmIds` option to specify the VMs.

```shell
$ osc-cli api StartVms --profile "default" \
    --VmIds '["i-12345678"]'
```

--------------------------------

### Example Cluster Information Output

Source: https://docs.outscale.com/fr/userguide/Obtenir-des-informations-sur-un-cluster.html

This is an example of the JSON output returned by the `oks-cli cluster get` command, showing various cluster attributes.

```json
{
    "project_id": "877295ad-171c-4f9a-86c5-d45c8b2321fe",
    "id": "5e5b232c-b7de-4cc0-9296-faa006b8bd25",
    "name": "NAME_OF_CLUSTER",
    "description": "",
    "cp_multi_az": false,
    "cp_subregions": [
        "2a"
    ],
    "version": "1.32",
    "cni": "cilium",
    "admin_lbu": false,
    "admission_flags": {
        "disable_admission_plugins": [],
        "enable_admission_plugins": [],
        "applied_admission_plugins": [
            "ClusterTrustBundleAttest",
            "LimitRanger",
            "RuntimeClass",
            "ServiceAccount",
            "CertificateApproval",
            "ResourceQuota",
            "PodSecurity",
            "Priority",
            "NamespaceLifecycle",
            "DefaultIngressClass",
            "PersistentVolumeClaimResize",
            "ValidatingAdmissionPolicy",
            "StorageObjectInUseProtection",
            "CertificateSigning",
            "DefaultStorageClass",
            "MutatingAdmissionWebhook",

```

--------------------------------

### Creating a VM (minimal syntax)

Source: https://docs.outscale.com/fr/userguide/Cr%C3%A9er-des-VM.html

This snippet shows the minimal configuration required to create a VM, including essential parameters like VM type, image ID, and root device configuration.

```json
{
  "Vms": [
    {
      "VmType": "t2.small",
      "VmInitiatedShutdownBehavior": "stop",
      "State": "pending",
      "StateReason": "",
      "RootDeviceType": "ebs",
      "RootDeviceName": "/dev/sda1",
      "IsSourceDestChecked": true,
      "ImageId": "ami-12345678",
      "DeletionProtection": false,
      "BootMode": "legacy",
      "TpmEnabled": false,
      "Architecture": "x86_64",
      "NestedVirtualization": false,
      "BlockDeviceMappings": [
        {
          "DeviceName": "/dev/sda1",
          "Bsu": {
            "VolumeId": "vol-12345678",
            "State": "attaching",
            "LinkDate": "2010-10-01T12:34:56.789Z",
            "DeleteOnVmDeletion": true
          }
        }
      ],
      "VmId": "i-12345678",
      "ReservationId": "r-12345678",
      "Hypervisor": "xen",
      "Placement": {
        "Tenancy": "default",
        "SubregionName": "eu-west-2a"
      },
      "ProductCodes": [
        "0001"
      ],
      "CreationDate": "2010-10-01T12:34:56.789Z",
      "UserData": "...",
      "PrivateIp": "10.0.0.4",
      "SecurityGroups": [
        {
          "SecurityGroupName": "default",
          "SecurityGroupId": "sg-12345678"
        }
      ],
      "BsuOptimized": false,
      "LaunchNumber": 0,
      "Performance": "medium",
      "Tags": [],
      "ActionsOnNextBoot": {
        "SecureBoot": "none"
      },
      "PrivateDnsName": "ip-10-0-0-4.eu-west-2.compute.internal"
    }
  ],
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}
```

--------------------------------

### Get Cluster Information (JSON Output)

Source: https://docs.outscale.com/fr/userguide/Tutoriel-Mettre-%C3%A0-niveau-la-version-Kubernetes-d-un-cluster.html

This is an example of the JSON output from the 'cluster get' command, showing details about the patch upgrade maintenance settings.

```json
{
...
        "patch_upgrade_maintenance": {
            "enabled": true,
            "duration_hours": 0,
            "start_hour": 12,
            "week_day": "Tue",
            "tz": "UTC"
        }

}
```

--------------------------------

### Example Kubeconfig Output

Source: https://docs.outscale.com/fr/userguide/Tutoriel-Mettre-en-place-un-fournisseur-OIDC-pour-l-authentification.html

This is an example of the output from printing the shareable kubeconfig file. It shows the cluster details, context, and user configuration, including the OIDC user setup.

```yaml
apiVersion: v1
clusters:
- cluster:
    certificate-authority-data: CLUSTER_CERTIFICATE==
    server: https://example-domain.123123123.project.eu-west-2.oks.outscale.com:6443
  name: NAME_OF_CLUSTER
contexts:
- context:
    cluster: NAME_OF_CLUSTER
    user: cluster-admin
  name: cluster-admin@NAME_OF_CLUSTER
current-context: cluster-admin@NAME_OF_CLUSTER
kind: Config
preferences: {}
users:
- name: oidc
  user: {}
```

--------------------------------

### Installer les paquets nécessaires pour la virtualisation

Source: https://docs.outscale.com/fr/userguide/Activer-la-virtualisation-imbriquée.html

Installez les paquets requis pour la gestion de la virtualisation, y compris virt-top, libguestfs-tools, et virt-install.

```bash
$ sudo dnf install @virt virt-top libguestfs-tools virt-install
```

--------------------------------

### Example Cluster Get Output

Source: https://docs.outscale.com/fr/userguide/Tutoriel-Mettre-%C3%A0-niveau-la-version-Kubernetes-d-un-cluster.html

This JSON output shows the current Kubernetes version (`version`) and the next available upgrade version (`available_upgrade`) for an OKS cluster.

```json
{
...
    "version": "1.28",
    "statuses": {
        "created_at": "2026-02-19T10:45:40.677486Z",
        "updated_at": "2026-02-19T10:52:42.303192Z",
        "status": "ready",
        "available_upgrade": "1.29"
    }
}
```

--------------------------------

### Tester le GPU avec CUDA Samples

Source: https://docs.outscale.com/fr/userguide/Installer-un-pilote-NVIDIA-sur-une-VM-Linux.html

Navigates to the CUDA bin directory, installs sample applications, and then compiles and runs a financial binomial options example to test GPU functionality.

```shell
$ cd /usr/local/cuda/bin
$ ./cuda-install-samples*.sh ~
$ cd ~/NVIDIA*/4_Finance/binomialOptions
$ make && make run
```

--------------------------------

### Example VM Launch Output

Source: https://docs.outscale.com/fr/userguide/Cr%C3%A9er-des-VM.html

This JSON output represents the details of a newly launched virtual machine instance. It includes information about its placement, network interfaces, block device mappings, and state.

```json
{
    "OwnerId": "1234567890000",
    "ReservationId": "r-87654321",
    "Groups": [
        {
            "GroupName": "default",
            "GroupId": "sg-12345678"
        }
    ],
    "Instances": [
        {
            "Monitoring": {
                "State": "disabled"
            },
            "PublicDnsName": "",
            "Platform": "",
            "State": {
                "Code": 0,
                "Name": "pending"
            },
            "EbsOptimized": false,
            "LaunchTime": "2016-04-20T08:26:26.540Z",
            "PrivateIpAddress": "10.10.10.4",
            "ProductCodes": [],
            "VpcId": "vpc-56781234",
            "InstanceId": "i-12345678",
            "ImageId": "ami-87654321",
            "PrivateDnsName": "ip-10-10-10-4.eu-west-2.compute.internal",
            "KeyName": "key name",
            "SecurityGroups": [
                {
                    "GroupName": "default",
                    "GroupId": "sg-12345678"
                }
            ],
            "ClientToken": "",
            "SubnetId": "subnet-56781234",
            "InstanceType": "t2.small",
            "NetworkInterfaces": [
                {
                    "Status": "in-use",
                    "MacAddress": "aa:c0:00:00:00:00",
                    "SourceDestCheck": true,
                    "VpcId": "vpc-56781234",
                    "Description": "Primary network interface",
                    "NetworkInterfaceId": "eni-12345678",
                    "PrivateIpAddresses": [
                        {
                            "PrivateDnsName": "ip-10-10-10-4.eu-west-2.compute.internal",
                            "Primary": true,
                            "PrivateIpAddress": "10.10.10.4"
                        }
                    ],
                    "PrivateDnsName": "ip-10-10-10-4.eu-west-2.compute.internal",
                    "Attachment": {
                        "Status": "attached",
                        "DeviceIndex": 0,
                        "DeleteOnTermination": true,
                        "AttachmentId": "eni-attach-12345678",
                        "AttachTime": "2016-04-20T08:26:26.540Z"
                    },
                    "Groups": [
                        {}
                    ],
                    "SubnetId": "subnet-56781234",
                    "OwnerId": "249064296596",
                    "PrivateIpAddress": "10.10.10.4"
                }
            ],
            "SourceDestCheck": true,
            "Placement": {
                "Tenancy": "default",
                "GroupName": "",
                "AvailabilityZone": "eu-west-2a"
            },
            "Hypervisor": "xen",
            "BlockDeviceMappings": [
                {
                    "DeviceName": "/dev/sda1",
                    "Ebs": {
                        "Status": "attaching",
                        "DeleteOnTermination": true,
                        "VolumeId": "vol-87654321",
                        "AttachTime": "2016-04-20T08:26:26.540Z"
                    }
                }
            ],
            "Architecture": "x86_64",
            "KernelId": "",
            "RootDeviceName": "/dev/sda1",
            "VirtualizationType": "hvm",
            "RootDeviceType": "ebs",
            "AmiLaunchIndex": 0
        }
    ]
}
```

--------------------------------

### Get Snapshot Information

Source: https://docs.outscale.com/fr/userguide/Obtenir-des-informations-sur-vos-snapshots.html

Use the `describe-snapshots` command to retrieve general information about your snapshots. You can specify a snapshot ID or use filters to narrow down the results. Ensure you have AWS CLI installed and configured.

```bash
aws ec2 describe-snapshots \
    --profile YOUR_PROFILE \
    --snapshot-id snap-12345678 \
    --filters Name=TAG_NAME,Values=TAG_VALUE \
    --endpoint https://fcu.eu-west-2.outscale.com
```

--------------------------------

### Créer une VM imbriquée avec virt-install

Source: https://docs.outscale.com/fr/userguide/Activer-la-virtualisation-imbriquée.html

Utilisez virt-install pour créer et configurer une nouvelle VM imbriquée, en spécifiant les ressources, le disque, le réseau et l'image d'installation.

```bash
$ sudo virt-install \
    --virt-type kvm \
    --name Debian11 \
    --ram 2024 \
    --disk /var/lib/libvirt/images/debian.qcow2 \
    --network network=default \
    --graphics vnc,listen=0.0.0.0 \
    --noautoconsole \
    --os-type=linux \
    --os-variant=generic \
    --cdrom=/var/lib/libvirt/images/debian-11.5.0-amd64-DVD-1.iso
```

--------------------------------

### Upgrade pip and Install OKS CLI on Windows

Source: https://docs.outscale.com/fr/userguide/Installer-et-configurer-OKS-CLI.html

Installs or upgrades pip, then installs the OKS CLI package. Ensure Python 3.11 is installed and added to PATH.

```shell
pip install --upgrade pip
pip install oks-cli
```

--------------------------------

### Install Docker Compose using PIP

Source: https://docs.outscale.com/fr/userguide/Wordpress.html

Installs Docker Compose using the Python Package Installer (PIP). This is an alternative method for installing Docker Compose if PIP is available.

```shell
pip install docker-compose
```

--------------------------------

### Install OSC CLI on Windows

Source: https://docs.outscale.com/fr/userguide/Installer-et-configurer-OSC-CLI.html

Install or upgrade pip and then install the OSC SDK package on Windows. Ensure Python 3 is installed and added to your system's PATH.

```shell
$ pip install --upgrade pip
$ pip install osc-sdk
```

--------------------------------

### Nettoyer les données cloud-init

Source: https://docs.outscale.com/fr/userguide/Nettoyage-des-VM-Linux-pour-cr%C3%A9er-des-OMI.html

Supprime les données stockées par cloud-init, qui sont utilisées pour l'initialisation de la VM. Exécutez cette commande en tant qu'utilisateur root.

```shell
$ cloud-init clean
```

--------------------------------

### Install Specific Packages

Source: https://docs.outscale.com/fr/userguide/Introduction-à-cloud-init.html

List additional packages to be installed. Supports installing by name or by name and version.

```yaml
#cloud-config
packages:
 - package_1
 - package_2
 - [package_3, version_num]
```

--------------------------------

### Creating a VM in a Net

Source: https://docs.outscale.com/fr/userguide/Cr%C3%A9er-des-VM.html

This snippet demonstrates how to create a VM within a specified network. It includes parameters for keypair name and network-related configurations.

```json
{
  "Vms": [
    {
      "VmType": "tinav5.c1r1p2",
      "VmInitiatedShutdownBehavior": "stop",
      "State": "pending",
      "StateReason": "",
      "RootDeviceType": "ebs",
      "RootDeviceName": "/dev/sda1",
      "IsSourceDestChecked": true,
      "KeypairName": "keypair-example",
      "ImageId": "ami-12345678",
      "DeletionProtection": false,
      "BootMode": "legacy",
      "TpmEnabled": false,
      "Architecture": "x86_64",
      "NestedVirtualization": false,
      "BlockDeviceMappings": [
        {
          "DeviceName": "/dev/sda1",
          "Bsu": {
            "VolumeId": "vol-12345678",
            "State": "attaching"
          }
        }
      ]
    }
  ]
}
```

--------------------------------

### Install Boto3

Source: https://docs.outscale.com/fr/userguide/Boto3.html

Install the Boto3 library using pip. Ensure Python 3.8 or later is installed.

```shell
pip install boto3
```

--------------------------------

### Basic cloud-config Example

Source: https://docs.outscale.com/fr/userguide/Introduction-%C3%A0-cloud-init.html

This example demonstrates a basic cloud-config file to create a user, set their group and shell, grant sudo privileges without a password, and add an SSH authorized key. It also creates an empty file named /test.txt.

```yaml
#cloud-config
users:
 - name: demo
   groups: sudo
   shell: /bin/bash
   sudo: ['ALL=(ALL) NOPASSWD:ALL']
   ssh-authorized-keys:
     - ssh-rsa
runcmd:
 - touch /test.txt
```

--------------------------------

### Install s3cmd using pip

Source: https://docs.outscale.com/fr/userguide/s3cmd.html

Install the s3cmd tool using pip if Python is already installed on your system.

```shell
$ pip3 install s3cmd
```

--------------------------------

### Creating a VM in a Net

Source: https://docs.outscale.com/fr/userguide/Cr%C3%A9er-des-VM.html

This snippet demonstrates creating a VM within a specific network, including parameters for keypair name and network configuration.

```json
{
  "Vms": [
    {
      "VmType": "tinav5.c1r1p2",
      "VmInitiatedShutdownBehavior": "stop",
      "State": "pending",
      "StateReason": "",
      "RootDeviceType": "ebs",
      "RootDeviceName": "/dev/sda1",
      "IsSourceDestChecked": true,
      "KeypairName": "keypair-example",
      "ImageId": "ami-12345678",
      "DeletionProtection": false,
      "BootMode": "legacy",
      "TpmEnabled": false,

```

--------------------------------

### Install OUTSCALE Python SDK

Source: https://docs.outscale.com/fr/userguide/SDK-Python-OUTSCALE.html

Install the SDK using pip. Ensure Python 3.10 or later is installed.

```shell
pip install osc-sdk-python
```

--------------------------------

### Install oapi-cli on macOS using Homebrew

Source: https://docs.outscale.com/fr/userguide/Installer-et-configurer-oapi-cli.html

Install oapi-cli on macOS by first tapping the Outscale Homebrew repository and then installing the oapi-cli package.

```shell
$ brew tap outscale/tap
$ brew install outscale/tap/oapi-cli
```

--------------------------------

### Créer une VM avec OUTSCALE CLI

Source: https://docs.outscale.com/fr/userguide/Tutoriel-D%C3%A9marrer-dans-le-Cloud-OUTSCALE.html

Lancez une nouvelle VM en spécifiant l'image, la keypair et le security group à utiliser.

```bash
$ oapi-cli CreateVms \
    --ImageId ami-xxxxxxxx \
    --KeypairName MyKeypair \
    --SecurityGroupIds '["sg-xxxxxxxx"]' \
    --MinVmsCount 1 \
    --MaxVmsCount 1
```

--------------------------------

### Configurer un bucket pour un site web

Source: https://docs.outscale.com/fr/userguide/Créer-un-site-web-dans-un-bucket.html

Utilisez cette commande pour configurer votre bucket OOS afin qu'il serve un site web statique. Le fichier website.json doit contenir la configuration du site web, y compris les fichiers d'index et d'erreur.

```bash
$ aws s3api put-bucket-website \
    --profile YOUR_PROFILE \
    --bucket BUCKET \
    --website-configuration file://~/path/to/website.json \
    --endpoint https://oos.eu-west-2.outscale.com
```

--------------------------------

### Install OSC CLI using Homebrew

Source: https://docs.outscale.com/fr/userguide/Installer-et-configurer-OSC-CLI.html

Install the OSC CLI package on macOS using the Homebrew package manager. Ensure Homebrew is installed first.

```shell
$ brew install osc-cli
```

--------------------------------

### Install OKS CLI using pip

Source: https://docs.outscale.com/fr/userguide/Installer-et-configurer-OKS-CLI.html

Installs the OKS CLI package from the Python Package Index (PyPI). Ensure Python 3.11 or later and pip are installed.

```shell
pip install oks-cli
```

--------------------------------

### Créer un projet avec OKS CLI

Source: https://docs.outscale.com/fr/userguide/Tutoriel-D%C3%A9marrer-avec-OKS-via-la-CLI-OKS.html

Utilisez la commande `project create` pour créer un nouveau projet OKS. Vous pouvez spécifier un nom, une description et des tags.

```shell
$ oks-cli project create \
    --project-name NAME_OF_PROJECT \
    --description "DESCRIPTION_OF_PROJECT" \
    --tags "tag1=this,tag2=that"
```

--------------------------------

### Kubeconfig Deletion Confirmation Example

Source: https://docs.outscale.com/fr/userguide/Tutoriel-Mettre-en-place-un-fournisseur-OIDC-pour-l-authentification.html

Example output confirming the deletion of a user from the kubeconfig file.

```text
deleted user cluster-admin from $KUBECONFIG
```

--------------------------------

### Configurer un bucket pour un site web

Source: https://docs.outscale.com/fr/userguide/Cr%C3%A9er-un-site-web-dans-un-bucket.html

Utilisez cette commande pour configurer votre bucket afin qu'il héberge un site web statique. Spécifiez le chemin vers votre fichier de configuration website.json.

```bash
aws s3api put-bucket-website \
    --profile YOUR_PROFILE \
    --bucket BUCKET \
    --website-configuration file://~/path/to/website.json \
    --endpoint https://oos.eu-west-2.outscale.com
```

--------------------------------

### Lier une IP publique à une VM avec oapi-cli

Source: https://docs.outscale.com/fr/userguide/Attacher-une-IP-publique-%C3%A0-une-VM-ou-%C3%A0-une-interface-r%C3%A9seau.html

Utilisez cette commande pour associer une adresse IP publique à une machine virtuelle existante. Assurez-vous que le profil 'default' est configuré.

```bash
$ oapi-cli --profile "default" LinkPublicIp \
    --PublicIp "192.0.2.0" \
    --VmId "i-12345678"
```

--------------------------------

### Ajouter un profil OKS avec identifiants

Source: https://docs.outscale.com/fr/userguide/Tutoriel-D%C3%A9marrer-avec-OKS-via-la-CLI-OKS.html

Utilisez cette commande pour ajouter un profil OKS en utilisant vos identifiants OUTSCALE. Assurez-vous que OKS CLI est installé et configuré.

```shell
$ oks-cli profile add \
    --profile-name "default" \
    --username "MY_LOGIN" \
    --password "MY_ACOUNT_PASSWORD" \
    --region "eu-west-2" \
    --jwt false
```

--------------------------------

### Supprimer un site web sur bucket avec AWS CLI

Source: https://docs.outscale.com/fr/userguide/Supprimer-un-site-web-sur-bucket.html

Utilisez cette commande pour supprimer la configuration du site web d'un bucket. Assurez-vous que AWS CLI est installé et configuré. Spécifiez votre profil, le nom du bucket et le endpoint de la région.

```bash
$ aws s3api delete-bucket-website \
    --profile YOUR_PROFILE \
    --bucket BUCKET \
    --endpoint https://oos.eu-west-2.outscale.com
```

--------------------------------

### Installer CUDA Toolkit 8.0 pour P2 GPU

Source: https://docs.outscale.com/fr/userguide/Installer-un-pilote-NVIDIA-sur-une-VM-Linux.html

Adds the NVIDIA CUDA repository and installs CUDA Toolkit 8.0.

```shell
$ yum-config-manager --add-repo https://developer.download.nvidia.com/compute/cuda/repos/rhel7/x86_64/cuda-rhel7.repo
$ yum clean all
$ yum -y install cuda-8-0
```

--------------------------------

### Example kubeconfig file path

Source: https://docs.outscale.com/fr/userguide/Acc%C3%A9der-%C3%A0-un-cluster.html

This is an example output showing the local path where the kubeconfig file is cached after a refresh or retrieval operation.

```text
/home/USER/.oks_cli/cache/ee46b46c-c20a-4c56-a791-74e523ec17ae-6f226690-76a0-4bd0-acc3-7ae078a31bf3/default/default/kubeconfig
```

--------------------------------

### Créer un disque dur virtuel pour la VM imbriquée

Source: https://docs.outscale.com/fr/userguide/Activer-la-virtualisation-imbriquée.html

Créez un disque dur virtuel au format qcow2 avec une taille spécifiée pour la nouvelle VM imbriquée.

```bash
$ sudo qemu-img create -f qcow2 /var/lib/libvirt/images/debian.qcow2 30G
```
Tokens:
Raw