Skip to main content

Manage Snapshots via CLI

Snapshots capture the complete state of your enterprise configuration at a specific point in time. Use snapshots to deploy consistent configurations across environments, roll back changes, or replicate setups to new clusters.

For comprehensive snapshot documentation and web UI management, see:

📚 System Versioning Concepts​

🌐 Web UI Guide: Snapshots​

Available CLI Commands​

Deploy Snapshot​

Deploy all assets from a snapshot to a target cabinet:

# Deploy specific snapshot version to cabinet
codiac snapshot deploy \
  --enterprise my-enterprise \
  --version 5CJRH7XB \
  --cabinet production

# Interactive mode (prompts for enterprise, version, cabinet)
codiac snapshot deploy

Alias: codiac cluster:install:snapshot

Use cases:

  • Restore previous configuration state
  • Deploy tested configuration to production
  • Replicate environment setup to new cluster
  • Disaster recovery

List Snapshots​

View all available snapshots in an enterprise:

# List snapshots for specific enterprise
codiac snapshot list --enterprise my-enterprise

# Interactive mode (prompts for enterprise)
codiac snapshot list

Output includes:

  • Snapshot version ID
  • Creation timestamp
  • Associated configurations
  • Tagged versions

Manage Snapshot Tags​

Create, list, and manage version tags for snapshots:

# Tag a snapshot version
codiac snapshot tags create \
  --enterprise my-enterprise \
  --version 5CJRH7XB \
  --tag stable

# List tags
codiac snapshot tags list --enterprise my-enterprise

# Delete tag
codiac snapshot tags delete \
  --enterprise my-enterprise \
  --tag stable

Common tags:

  • stable - Known good configuration
  • production - Currently deployed in prod
  • v1.0.0 - Semantic version tags
  • before-migration - Pre-change backup

Common Workflows​

Promote Configuration Across Environments​

# 1. List available snapshots
codiac snapshot list --enterprise my-enterprise

# 2. Deploy dev snapshot to staging
codiac snapshot deploy \
  --enterprise my-enterprise \
  --version ABC123XY \
  --cabinet staging

# 3. Tag if successful
codiac snapshot tags create \
  --enterprise my-enterprise \
  --version ABC123XY \
  --tag staging-validated

Disaster Recovery​

# 1. Find last known good snapshot
codiac snapshot tags list --enterprise my-enterprise

# 2. Deploy tagged snapshot
codiac snapshot deploy \
  --enterprise my-enterprise \
  --version STABLE_VERSION_ID \
  --cabinet production

Manage snapshots visually: Codiac Web UI - Snapshots