# Documentation for `scw datalab`


:::note{title="The CLI documentation pages are currently under construction"}
The content is up to date. We're making improvements to the site over the next few weeks for a better experience.
:::

<!-- DO NOT EDIT: this file is automatically generated using scw-doc-gen -->
Clusters for Apache Spark™ API.

- [](#)
  - [List datalab resources](#list-datalab-resources)
- [](#)
  - [Create datalab resources](#create-datalab-resources)
  - [Delete datalab resources](#delete-datalab-resources)
  - [Get datalab resources](#get-datalab-resources)
  - [List datalab resources](#list-datalab-resources)
  - [Update datalab resources](#update-datalab-resources)
- [](#)
  - [List datalab resources](#list-datalab-resources)
- [](#)
  - [List datalab resources](#list-datalab-resources)


## 

Lists the Apache Spark™ versions available for cluster creation.


### List datalab resources

List datalab resources.

**Usage:**

```shell
scw datalab cluster-version list [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| order-by | One of: `name_asc`, `name_desc` | The order by field. |
| region | Default: `fr-par`<br />One of: `fr-par`, `it-mil`, `all` | Region to target. If none is passed will use default region from the config |



## 

Manage your clusters.


### Create datalab resources

Create datalab resources.

**Usage:**

```shell
scw datalab datalab create [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| project-id |  | Project ID to use. If none is passed the default project ID will be used |
| name |  | The name of the cluster. |
| description |  | The description of the cluster. |
| tags.{index} |  | The tags of the cluster. |
| main.node-type |  |  |
| worker.node-type |  |  |
| worker.node-count |  |  |
| has-notebook |  | Select this option to include a notebook as part of the cluster. |
| spark-version |  | The version of Apache Spark™ running inside the cluster, available options can be viewed at ListClusterVersions. |
| total-storage.type | One of: `unknown_type`, `sbs_5k` |  |
| total-storage.size |  |  |
| private-network-id |  | The unique identifier of the private network the cluster will be attached to. |
| region | Default: `fr-par`<br />One of: `fr-par`, `it-mil` | Region to target. If none is passed will use default region from the config |



### Delete datalab resources

Delete datalab resources.

**Usage:**

```shell
scw datalab datalab delete [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| datalab-id | Required | The unique identifier of the cluster. |
| region | Default: `fr-par`<br />One of: `fr-par`, `it-mil` | Region to target. If none is passed will use default region from the config |



### Get datalab resources

Get datalab resources.

**Usage:**

```shell
scw datalab datalab get [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| datalab-id | Required | The unique identifier of the cluster |
| region | Default: `fr-par`<br />One of: `fr-par`, `it-mil` | Region to target. If none is passed will use default region from the config |



### List datalab resources

List datalab resources.

**Usage:**

```shell
scw datalab datalab list [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| project-id |  | The unique identifier of the project whose clusters you want to list. |
| name |  | The name of the cluster you want to list. |
| tags.{index} |  | The tags associated with the cluster you want to list. |
| order-by | One of: `name_asc`, `name_desc`, `created_at_asc`, `created_at_desc`, `updated_at_asc`, `updated_at_desc` | The order by field, available options are `name_asc`, `name_desc`, `created_at_asc`, `created_at_desc`, `updated_at_asc`, `updated_at_desc`. |
| organization-id |  | The unique identifier of the organization whose clusters you want to list. |
| region | Default: `fr-par`<br />One of: `fr-par`, `it-mil`, `all` | Region to target. If none is passed will use default region from the config |



### Update datalab resources

Update datalab resources.

**Usage:**

```shell
scw datalab datalab update [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| datalab-id | Required | The unique identifier of the cluster. |
| name |  | The updated name of the cluster. |
| description |  | The updated description of the cluster. |
| tags.{index} |  | The updated tags of the cluster. |
| node-count |  | The updated node count of the cluster. Scale up or down the number of worker nodes. |
| region | Default: `fr-par`<br />One of: `fr-par`, `it-mil` | Region to target. If none is passed will use default region from the config |



## 

List available node types.


### List datalab resources

List datalab resources.

**Usage:**

```shell
scw datalab node-type list [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| order-by | One of: `name_asc`, `name_desc`, `vcpus_asc`, `vcpus_desc`, `memory_gigabytes_asc`, `memory_gigabytes_desc`, `vram_bytes_asc`, `vram_bytes_desc`, `gpus_asc`, `gpus_desc` | The order by field. Available fields are `name_asc`, `name_desc`, `vcpus_asc`, `vcpus_desc`, `memory_gigabytes_asc`, `memory_gigabytes_desc`, `vram_bytes_asc`, `vram_bytes_desc`, `gpus_asc`, `gpus_desc`. |
| targets.{index} | One of: `unknown_target`, `notebook`, `worker` | Filter based on the target of the nodes. Allows to filter the nodes based on their purpose which can be main or worker node. |
| resource-type | One of: `all`, `gpu`, `cpu` | Filter based on node type ( `cpu`/`gpu`/`all` ). |
| region | Default: `fr-par`<br />One of: `fr-par`, `it-mil`, `all` | Region to target. If none is passed will use default region from the config |



## 

List available notebook versions.


### List datalab resources

List datalab resources.

**Usage:**

```shell
scw datalab notebook-version list [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| order-by | One of: `name_asc`, `name_desc` | The order by field. Available options are `name_asc` and `name_desc`. |
| region | Default: `fr-par`<br />One of: `fr-par`, `it-mil`, `all` | Region to target. If none is passed will use default region from the config |