# Manage object stores using the CLI Using the CLI, you can perform the following actions: * [View object stores](#view-object-stores) * [Add an object store](#add-an-object-store-bucket) * [View object store buckets](#view-object-store-buckets) * [Add an object store bucket](#add-an-object-store-bucket) * [Edit an object store bucket](#edit-an-object-store-bucket) * [Delete an object store bucket](#delete-an-object-store-bucket) ## View object stores **Command:** `weka fs tier obs` This command is used to view information on all the object stores configured to the Weka system. {% hint style="info" %} **Note:** Using the GUI only object-store buckets are present. Adding an object-store bucket will add it to the only `local` or `remote` object-store present. If more than one is present (such as during the time recovering from a remote snapshot), the CLI should be used. {% endhint %} ## Edit an object store **Command:** `weka fs tier obs update` Use the following command line to edit an object store: `weka fs tier obs update [--new-name new-name] [--site site] [--hostname=] [--port=] [--auth-method=] [--region=] [--access-key-id=] [--secret-key=] [--protocol=] [--bandwidth=] [--download-bandwidth=] [--upload-bandwidth=] [--max-concurrent-downloads=] [--max-concurrent-uploads=] [--max-concurrent-removals=] [--enable-upload-tags=]` **Parameters** | **Name** | **Type** | **Value** | **Limitations** | **Mandatory** | **Default** | | -------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | ------------- | ----------- | | `name` | String | Name of the object store being created | Must be a valid name | Yes | ​ | | `new-name` | String | New name for the object store | Must be a valid name | No | | | `site` | String | `local` - for tiering+snapshots, `remote` - for snapshots only | `local` or `remote` | No | | | `hostname` | String | Object store host identifier, to be used as a default for added buckets | Must be a valid name/IP | No | | | `port` | String | Object store port, to be used as a default for added buckets | Must be a valid name | No | | | `auth-method` | String | Authentication method, to be used as a default for added buckets | `None`, `AWSSignature2` or `AWSSignature4` | No | | | `region` | String | Region name, to be used as a default for added buckets | | No | | | `access-key-id` | String | Object store access key ID, to be used as a default for added buckets | | No | | | `secret-key` | String | Object store secret key, to be used as a default for added buckets | | No | | | `protocol` | String | Protocol type, to be used as a default for added buckets | `HTTP`, `HTTPS` or `HTTPS_UNVERIFIED` | No | | | `bandwidth` | Number | Bandwidth limitation per core (Mbps) | | No | | | `download-bandwidth` | Number | Object-store download bandwidth limitation per core (Mbps) | | No | | | `upload-bandwidth` | Number | Object-store upload bandwidth limitation per core (Mbps) | | No | | | `max-concurrent-downloads` | Number | Maximum number of downloads concurrently performed on this object store in a single IO node | 1-64 | No | | | `max-concurrent-uploads` | Number | Maximum number of uploads concurrently performed on this object store in a single IO node | 1-64 | No | | | `max-concurrent-removals` | Number | Maximum number of removals concurrently performed on this object store in a single IO node | 1-64 | No | | | `enable-upload-tags` | String | Whether to enable [object-tagging](/4.0/fs/tiering/data-management-in-tiered-filesystems.md#object-tagging) or not, to be used as a default for added buckets | `true` or `false` | No | | ### View object store buckets **Command:** `weka fs tier s3` This command is used to view information on all the object-store buckets configured to the Weka system. ## Add an object store bucket **Command:** `weka fs tier s3 add` Use the following command line to add an object store: `weka fs tier s3 add [--site site] [--obs-name obs-name] [--hostname=] [--port= [--bucket=] [--auth-method=] [--region=] [--access-key-id=] [--secret-key=] [--protocol=] [--bandwidth=] [--download-bandwidth=] [--upload-bandwidth=] [--errors-timeout=] [--prefetch-mib=] [--enable-upload-tags=]` **Parameters** | **Name** | **Type** | **Value** | **Limitations** | **Mandatory** | **Default** | | -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `name` | String | Name of the object-store bucket being created | Must be a valid name | Yes | ​ | | `site` | String | `local` - for tiering+snapshots, `remote` - for snapshots only | Must be the same as the object store site it is added to `(obs-name)` | No | `local` | | `obs-name` | String | Name of the object-store to add this object-store bucket to | Must be an existing object-store | No | If there is only one object-store of type mentioned in `site` it is chosen automatically | | `hostname` | String | Object store host identifier | Must be a valid name/IP | Yes, if not specified in the object-store level | The `hostname` specified in `obs-name` if present | | `port` | String | Object store port | Must be a valid name | No | The `port` specified in `obs-name` if present, otherwise 80 | | `bucket` | String | Object store bucket name | Must be a valid name | Yes | | | `auth-method` | String | Authentication method | `None`, `AWSSignature2` or `AWSSignature4` | Yes, if not specified in the object-store level | The `auth-method` specified in `obs-name` if present | | `region` | String | Region name | | Yes, if not specified in the object-store level | The `region` specified in `obs-name` if present | | `access-key-id` | String | Object store bucket access key ID | | Yes, if not specified in the object-store level (can be left empty when using IAM role in AWS) | The `access-key-id` specified in `obs-name` if present | | `secret-key` | String | Object store bucket secret key | | Yes, if not specified in the object-store level (can be left empty when using IAM role in AWS) | The `secret-key` specified in `obs-name` if present | | `protocol` | String | Protocol type to be used | `HTTP`, `HTTPS` or `HTTPS_UNVERIFIED` | No | The `protocol` specified in `obs-name` if present, otherwise`HTTP` | | `bandwidth` | Number | Bucket bandwidth limitation per core (Mbps) | | No | | | `download-bandwidth` | Number | Bucket download bandwidth limitation per core (Mbps) | | No | | | `upload-bandwidth` | Number | Bucket upload bandwidth limitation per core (Mbps) | | No | | | `errors-timeout` | Number | If the object-store link is down for longer than this timeout period, all IOs that need data return with an error | 1-15 minutes, e.g: 5m or 300s | No | 300 | | `prefetch-mib` | Number | How many MiB of data to prefetch when reading a whole MiB on the object store | | No | 0 | | `enable-upload-tags` | String | Whether to enable [object-tagging](/4.0/fs/tiering/data-management-in-tiered-filesystems.md#object-tagging) or not | `true` or `false` | No | `false` | {% hint style="info" %} **Note:** When using the CLI, by default a misconfigured object store will not be created. To create an object store even when it is misconfigured, use the `--skip-verification`option. {% endhint %} {% hint style="warning" %} **Note:** The `max-concurrent` settings are applied per Weka compute process and the minimum setting of all object-stores is applied. {% endhint %} Make the relevant changes and click Update to update the object store bucket. ## Edit an object store bucket **Command:** `weka fs tier s3 update` Use the following command line to edit an object-store bucket: `weka fs tier s3 update [--new-name=] [--new-obs-name new-obs-name] [--hostname=] [--port= [--bucket=] [--auth-method=] [--region=] [--access-key-id=] [--secret-key=] [--protocol=] [--bandwidth=] [--download-bandwidth=] [--upload-bandwidth=] [--errors-timeout=] [--prefetch-mib=] [--enable-upload-tags=]` **Parameters** | **Name** | **Type** | **Value** | **Limitations** | **Mandatory** | **Default** | | -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------- | ------------- | ----------- | | `name` | String | Name of the object-store bucket being edited | Must be a valid name | Yes | ​ | | `new-name` | String | New name for the object-store bucket | Must be a valid name | No | | | `new-obs-name` | String | New name of the object-store to add this object-store bucket to | Must be an existing object-store, with the same `site` value. | No | | | `hostname` | String | Object store host identifier | Must be a valid name/IP | No | | | `port` | String | Object store port | Must be a valid name | No | | | `bucket` | String | Object store bucket name | Must be a valid name | No | | | `auth-method` | String | Authentication method | `None`, `AWSSignature2` or `AWSSignature4` | No | | | `region` | String | Region name | | No | | | `access-key-id` | String | Object-store bucket access key ID | | No | | | `secret-key` | String | Object-store bucket secret key | | No | | | `protocol` | String | Protocol type to be used | `HTTP`, `HTTPS` or `HTTPS_UNVERIFIED` | No | | | `bandwidth` | Number | Bandwidth limitation per core (Mbps) | | No | | | `download-bandwidth` | Number | Bucket download bandwidth limitation per core (Mbps) | | No | | | `upload-bandwidth` | Number | Bucket upload bandwidth limitation per core (Mbps) | | No | | | `errors-timeout` | Number | If the object-store link is down for longer than this timeout period, all IOs that need data return with an error | 1-15 minutes, e.g: 5m or 300s | No | | | `prefetch-mib` | Number | How many MiB of data to prefetch when reading a whole MiB on the object store | | No | | | `enable-upload-tags` | String | Whether to enable [object-tagging](/4.0/fs/tiering/data-management-in-tiered-filesystems.md#object-tagging) or not | `true` or `false` | No | | ## Delete an object store bucket **Command:** `weka fs tier s3 delete` Use the following command line to delete an object-store bucket: `weka fs tier s3 delete ` **Parameters** | **Name** | **Type** | **Value** | **Limitations** | **Mandatory** | **Default** | | -------- | -------- | --------------------------------------------- | -------------------- | ------------- | ----------- | | `name` | String | Name of the object-store bucket being deleted | Must be a valid name | Yes | ​ | --- # 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.0/fs/managing-object-stores/managing-object-stores-1.md?ask= ``` 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.