# Manage the S3 service using the CLI

Using the CLI, you can:

* [Create an S3 cluster](#create-an-s3-cluster)
* [Check the status of the S3 cluster readiness](#check-the-status-of-the-s3-cluster-readiness)
* [List the S3 cluster containers](#list-the-s3-cluster-containers)
* [Update an S3 cluster configuration](#update-an-s3-cluster-configuration)
* [Add containers to the S3 cluster](#add-containers-to-the-s3-cluster)
* [Remove containers from the S3 cluster](#remove-hosts-from-the-s3-cluster)
* [Delete an S3 cluster](#delete-an-s3-cluster)

## Create an S3 cluster

**Command:** `weka s3 cluster create`

Use the following command line to create an S3 cluster:

`weka s3 cluster create <default-fs-name> <config-fs-name> [--port port] [--key key] [--secret secret] [--max-buckets-limit max-buckets-limit] [--anonymous-posix-uid anonymous-posix-uid] [--anonymous-posix-gid anonymous-posix-gid] [--domain domain] [--container-id container-id]... [--all-servers]`

{% hint style="warning" %}
**Note:** As a best practice, it is recommended to have only one of the following protocol containers, NFS, SMB, or S3, installed on the same server. Starting from version 4.2, setting more than one additional protocol to the existing POSIX is not allowed.
{% endhint %}

**Parameters**

| **Name**              | **Type**                        | **Value**                                                                                                                                                                                                                         | **Limitations**                                | **Mandatory**                                                     | **Default**                                                                                                                                          |
| --------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `default-fs-name`     | String                          | The filesystem name to be used for the S3 service.                                                                                                                                                                                | None                                           | Yes                                                               |                                                                                                                                                      |
| `config-fs-name`      | String                          | The filesystem used for persisting cluster-wide configuration for all protocols.                                                                                                                                                  | Must be the same filesystem for all protocols. | Yes                                                               |                                                                                                                                                      |
| `port`                | Number                          | The port where the S3 service is exposed.                                                                                                                                                                                         | Do not set port 9001                           | No                                                                | 9000                                                                                                                                                 |
| `key`                 | String                          | The object store bucket access key ID.                                                                                                                                                                                            | Must be a valid key                            | No                                                                | As set when [adding an object store bucket](https://docs.weka.io/4.1/fs/managing-object-stores/managing-object-stores-1#add-an-object-store-bucket). |
| `secret`              | String                          | The object store bucket secret key.                                                                                                                                                                                               | Must be a valid secret key                     | No                                                                | As set when [adding an object store bucket](https://docs.weka.io/4.1/fs/managing-object-stores/managing-object-stores-1#add-an-object-store-bucket). |
| `max-buckets-limit`   | Number                          | The maximum number of buckets that can be created.                                                                                                                                                                                | 10000                                          | No                                                                |                                                                                                                                                      |
| `anonymous-posix-uid` | Number                          | POSIX UID for objects (when accessed via POSIX) created with anonymous access (for buckets with an IAM policy allowing that).                                                                                                     | None                                           | No                                                                | 65534                                                                                                                                                |
| `anonymous-posix-gid` | Number                          | POSIX GID for objects (when accessed via POSIX) created with anonymous access (for buckets with an IAM policy allowing that).                                                                                                     | None                                           | No                                                                | 65534                                                                                                                                                |
| `domain`              | String                          | <p>Virtual hosted-style comma-separated domains.</p><p>Example: <code>--domain sub1.domain-name.com,sub3.domain-name.com</code>.<br>To remove the existing domain, set <code>""</code>.<br>Example: <code>--domain ""</code>.</p> | Maximum 1024 characters                        | No                                                                |                                                                                                                                                      |
| `container-id`        | Comma-separated list of Numbers | Container IDs of containers with a frontend process to serve the S3 service.                                                                                                                                                      | Specify a minimum of 3 containers              | Either `all-servers` or a list of `container-id` must be provided |                                                                                                                                                      |
| `all-servers`         | Boolean                         | Use all backend servers to serve S3 commands.                                                                                                                                                                                     | None                                           | Either `all-servers` or a list of `container-id` must be provided | Off                                                                                                                                                  |

## Check the status of the S3 cluster readiness

**Command:** `weka s3 cluster` or `weka s3 cluster status`

The S3 cluster is comprised of a few S3 containers. Use this command to check the status of the S3 containers that are part of the S3 cluster. Once all the S3 containers are prepared and ready, it is possible to use the S3 service.

## List the S3 cluster containers <a href="#list-the-s3-cluster-containers" id="list-the-s3-cluster-containers"></a>

**Command:** `weka s3 cluster containers list`

Use this command to list the containers that serve the S3 cluster.

## Update an S3 cluster configuration <a href="#update-an-s3-cluster-configuration" id="update-an-s3-cluster-configuration"></a>

**Command:** `weka s3 cluster update`

Use the following command line to update an S3 cluster configuration:

`weka s3 cluster update [--key key] [--secret secret] [--port port] [--anonymous-posix-uid anonymous-posix-uid] [--anonymous-posix-gid anonymous-posix-gid] [--domain domain] [--container container]... [--all-servers]`

**Parameters**

<table data-header-hidden><thead><tr><th width="208">Name</th><th width="150">Type</th><th width="240">Value</th><th width="150">Limitations</th><th width="149">Mandatory</th><th>Default</th></tr></thead><tbody><tr><td><strong>Name</strong></td><td><strong>Type</strong></td><td><strong>Value</strong></td><td><strong>Limitations</strong></td><td><strong>Mandatory</strong></td><td><strong>Default</strong></td></tr><tr><td><code>key</code></td><td>String</td><td>The object store bucket access key ID.</td><td>Must be a valid key</td><td>No</td><td>As set when <a href="../../../../fs/managing-object-stores/managing-object-stores-1#add-an-object-store-bucket">adding an object store bucket</a>.</td></tr><tr><td><code>secret</code></td><td>String</td><td>The object store bucket secret key.</td><td>Must be a valid secret key</td><td>No</td><td>As set when <a href="../../../../fs/managing-object-stores/managing-object-stores-1#add-an-object-store-bucket">adding an object store bucket</a>.</td></tr><tr><td><code>port</code></td><td>Number</td><td>The port where the S3 service is exposed.</td><td>Do not set port 9001</td><td></td><td></td></tr><tr><td><code>anonymous-posix-uid</code></td><td>Number</td><td>POSIX UID for objects  (when accessed via POSIX) created with anonymous access (for buckets with an IAM policy allowing that).</td><td>None</td><td>No</td><td>65534</td></tr><tr><td><code>anonymous-posix-gid</code></td><td>Number</td><td>POSIX GID for objects  (when accessed via POSIX) created with anonymous access (for buckets with an IAM policy allowing that).</td><td>None</td><td>No</td><td>65534</td></tr><tr><td><code>domain</code></td><td>String</td><td><p>Virtual-hosted-style comma-separated domains.</p><p>Example: <code>--domain sub1.domain-name.com,sub3.domain-name.com</code>.<br>To remove the existing domain, set <code>""</code>. <br>Example: <code>--domain ""</code>.</p></td><td>Maximum 1024 characters</td><td>No</td><td></td></tr><tr><td><code>container</code></td><td>Comma-separated list of numbers</td><td>Container IDs of containers with frontend processes to serve the S3 service.</td><td>Minimum 3 containers</td><td>Either <code>container</code> list or <code>all-servers</code> must be provided.</td><td></td></tr><tr><td><code>all-servers</code></td><td>Boolean</td><td>Use all backend servers to serve S3 commands.</td><td>None</td><td>Either <code>container</code> list or <code>all-servers</code> must be provided.</td><td>Off</td></tr></tbody></table>

{% hint style="info" %}
**Note:** Instead of using the `weka s3 cluster update` command for adding or removing containers, use the commands `weka s3 cluster containers add` or `weka s3 cluster containers remove`. It is more convenient when managing an S3 cluster with many containers.
{% endhint %}

## Add containers to the S3 cluster

**Command:** `weka s3 cluster containers add`

Use the following command line to add containers to the S3 cluster:

`weka s3 cluster containers add <container-ids>`

The following command example adds two containers with the IDs 8 and 9:

`weka s3 cluster containers add 8 9`

**Parameters**

| **Name**        | **Type**                        | **Value**                               | **Mandatory** | **Default** |
| --------------- | ------------------------------- | --------------------------------------- | ------------- | ----------- |
| `container-ids` | Space-separated list of numbers | Container IDs to add to the S3 cluster. | Yes           |             |

## Remove containers from the S3 cluster

**Command:** `weka s3 cluster containers remove`

Use the following command line to remove containers from the S3 cluster:

`weka s3 cluster containers remove <container-ids>`

**Parameters**

| **Name**        | **Type**                        | **Value**                                    | **Mandatory** | **Default** |
| --------------- | ------------------------------- | -------------------------------------------- | ------------- | ----------- |
| `container-ids` | Space-separated list of numbers | Container IDs to remove from the S3 cluster. | Yes           |             |

## Delete an S3 cluster

**Command:** `weka s3 cluster destroy`

Use this command to destroy an S3 cluster managed by the Weka system.

Deleting an existing S3 cluster removes the S3 service and configuration, such as IAM policies, buckets, and ILM rules. S3 access is no longer available for clients. Data within the buckets is not deleted. Internal users with S3 roles are deleted from the system.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.weka.io/4.1/additional-protocols/s3/s3-cluster-management/s3-cluster-management-1.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.