Skip to content

Redis Enterprise

Redis Enterprise is Redis's self-managed database platform for on-premises or cloud deployments. redisctl provides complete CLI access to the REST API.

Three-Tier Access

graph LR
    A[API Layer] --> B[Commands]
    B --> C[Workflows]

    style A fill:#e5c07b,color:#000
    style B fill:#98c379,color:#000
    style C fill:#61afef,color:#000

1. API Layer

Direct REST access for scripting and automation: 

redisctl api enterprise get /v1/cluster
redisctl api enterprise post /v1/bdbs -d @database.json

2. Commands

Human-friendly commands for day-to-day operations: 

redisctl cluster get                                      # prefix optional
redisctl database create --name mydb --memory-size 1073741824

3. Workflows

Multi-step operations: 

redisctl enterprise workflow init-cluster --name prod --nodes 3

Key Concepts

Cluster

The cluster is the top-level container that spans multiple nodes. It manages:

  • Node membership
  • Resource allocation
  • Policies and certificates
  • License

Nodes

Physical or virtual machines running Redis Enterprise. Each node provides:

  • CPU and memory resources
  • Network connectivity
  • Storage for persistence

Databases (BDBs)

Databases run across the cluster. Each database has:

  • Memory allocation
  • Sharding configuration
  • Replication settings
  • Modules (RedisJSON, RediSearch, etc.)

Authentication

export REDIS_ENTERPRISE_URL="https://cluster.example.com:9443"
export REDIS_ENTERPRISE_USER="admin@cluster.local"
export REDIS_ENTERPRISE_PASSWORD="your-password"
export REDIS_ENTERPRISE_INSECURE="true"  # for self-signed certs

redisctl profile set enterprise \
  --enterprise-url "https://cluster.example.com:9443" \
  --enterprise-user "admin@cluster.local" \
  --enterprise-password "your-password" \
  --enterprise-insecure

Self-Signed Certificates

Most Enterprise clusters use self-signed certificates. Set REDIS_ENTERPRISE_INSECURE=true or use --enterprise-insecure in profiles.

Quick Examples

# Get cluster info (enterprise-only, prefix optional)
redisctl cluster get

# List databases
redisctl database list -o table

# Create database
redisctl database create \
  --name cache \
  --memory-size 1073741824

# Stream cluster stats
redisctl stats cluster --follow

# Generate support package
redisctl support-package cluster --upload

Prefix-free commands

The enterprise prefix is optional when your profile is an Enterprise profile. All examples above work with or without redisctl enterprise .... See Platform Inference for details.

Command Groups

  • Cluster

    Cluster configuration and status

    Commands

  • Databases

    Create, configure, and manage databases

    Commands

  • Nodes

    Node status and management

    Commands

  • Access Control

    Users, roles, and LDAP configuration

    Commands

  • Monitoring

    Stats, alerts, and logs

    Commands

  • Active-Active

    CRDB management

    Commands

Operations

  • Support Package

    Generate diagnostic packages for Redis Support

    Guide

  • Debug Info

    Collect debugging information

    Guide

Next Steps