> For the complete documentation index, see [llms.txt](https://boxlang.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://boxlang.ortusbooks.com/boxlang-+-++/modules/bx-redis/built-in-functions/redisgetcluster.md).

# RedisGetCluster

Returns the Redis Cache Cluster provider by name.

## Method Signature

```
RedisGetCluster(cacheName=[any])
```

### Arguments

| Argument    | Type  | Required | Description                         | Default |
| ----------- | ----- | -------- | ----------------------------------- | ------- |
| `cacheName` | `any` | `true`   | The name of the redis cache to get. |         |

## Examples

Get a Redis cluster instance for cache operations:

```js
// Get the cluster from a Redis cache
var cluster = RedisGetCluster( "myRedisCache" );

// Check if it's a cluster
if ( cluster != null ) {
    println( "Successfully retrieved Redis cluster" );
}
```

Access cluster information:

```js
// Get cluster and perform cluster-specific operations
var cluster = RedisGetCluster( "myRedisCache" );

// Get cluster info
var info = cluster.clusterInfo();
println( info );
```

## Related

* [RedisGetProvider()](/boxlang-+-++/modules/bx-redis/built-in-functions/redisgetprovider.md) - Get the Redis cache provider
* [RedisGetConnectionPool()](/boxlang-+-++/modules/bx-redis/built-in-functions/redisgetconnectionpool.md) - Get the connection pool
* [RedisGetClusterNodes()](/boxlang-+-++/modules/bx-redis/built-in-functions/redisgetclusternodes.md) - Get cluster node information
* [API Usage Guide](/boxlang-+-++/modules/bx-redis/api-usage.md) - Redis API documentation


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://boxlang.ortusbooks.com/boxlang-+-++/modules/bx-redis/built-in-functions/redisgetcluster.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.