> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/aistore/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/aistore/_mcp/server.

# aistore.sdk.authn.cluster_manager

## Module Contents

### Classes

| Name                                                                  | Description                                                                                    |
| --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| [`ClusterManager`](#aistore-sdk-authn-cluster_manager-ClusterManager) | ClusterManager class for handling operations on clusters within the context of authentication. |

### Data

[`logger`](#aistore-sdk-authn-cluster_manager-logger)

### API

```python
class aistore.sdk.authn.cluster_manager.ClusterManager(
    client: aistore.sdk.request_client.RequestClient
)
```

ClusterManager class for handling operations on clusters within the context of authentication.

This class provides methods to list, get, register, update, and delete clusters on AuthN server.

**Parameters:**

The request client to make HTTP requests.

RequestClient: The client this cluster manager uses to make requests.

```python
aistore.sdk.authn.cluster_manager.ClusterManager.delete(
    cluster_id: typing.Optional[str] = None,
    cluster_alias: typing.Optional[str] = None
)
```

Delete a specific cluster by ID or alias.

**Parameters:**

The ID of the cluster to delete. Defaults to None.

The alias of the cluster to delete. Defaults to None.

**Raises:**

* `ValueError`: If neither cluster\_id nor cluster\_alias is provided.
* `AISError`: If an error occurs while deleting the cluster

```python
aistore.sdk.authn.cluster_manager.ClusterManager.get(
    cluster_id: typing.Optional[str] = None,
    cluster_alias: typing.Optional[str] = None
) -> aistore.sdk.authn.types.ClusterInfo
```

Retrieve a specific cluster by ID or alias.

**Parameters:**

The ID of the cluster. Defaults to None.

The alias of the cluster. Defaults to None.

**Returns:** `ClusterInfo`

Information about the specified cluster.

**Raises:**

* `ValueError`: If neither cluster\_id nor cluster\_alias is provided.
* `RuntimeError`: If no cluster matches the provided ID or alias.
* `AISError`: If an error occurs while getting the cluster.

```python
aistore.sdk.authn.cluster_manager.ClusterManager.list() -> aistore.sdk.authn.types.ClusterList
```

Retrieve all clusters.

**Returns:** `ClusterList`

A list of all clusters.

**Raises:**

* `AISError`: If an error occurs while listing clusters.

```python
aistore.sdk.authn.cluster_manager.ClusterManager.register(
    cluster_alias: str,
    urls: typing.List[str]
) -> aistore.sdk.authn.types.ClusterInfo
```

Register a new cluster.

**Parameters:**

The alias for the new cluster.

A list of URLs for the new cluster.

**Returns:** `ClusterInfo`

Information about the registered cluster.

**Raises:**

* `ValueError`: If no URLs are provided or an invalid URL is provided.
* `AISError`: If an error occurs while registering the cluster.

```python
aistore.sdk.authn.cluster_manager.ClusterManager.update(
    cluster_id: str,
    cluster_alias: typing.Optional[str] = None,
    urls: typing.Optional[typing.List[str]] = None
) -> aistore.sdk.authn.types.ClusterInfo
```

Update an existing cluster.

**Parameters:**

The ID of the cluster to update.

The new alias for the cluster. Defaults to None.

The new list of URLs for the cluster. Defaults to None.

**Returns:** `ClusterInfo`

Information about the updated cluster.

**Raises:**

* `ValueError`: If neither cluster\_alias nor urls are provided.
* `AISError`: If an error occurs while updating the cluster

```python
aistore.sdk.authn.cluster_manager.logger = get_logger(__name__)
```