{
  "id": "redis-di-dump-support-package",
  "title": "redis-di dump-support-package",
  "url": "https://redis.io/docs/latest/integrate/write-behind/reference/cli/redis-di-dump-support-package/",
  "summary": "Dumps Write-behind support package",
  "tags": [
    "docs",
    "integrate",
    "rs",
    "rdi"
  ],
  "last_updated": "2026-04-01T08:10:08-05:00",
  "page_type": "content",
  "content_hash": "644b255fdfae4290ac47624ccb2d7a30f95dc34f4ddcd85cad8e633a6f4c14d8",
  "sections": [
    {
      "id": "usage",
      "title": "Usage",
      "role": "syntax",
      "text": "[code example]"
    },
    {
      "id": "options",
      "title": "Options",
      "role": "parameters",
      "text": "- `loglevel`:\n\n  - Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'])\n  - Default: `info`\n  - Usage: `--loglevel\n-log-level`\n\n- `rdi_host` (REQUIRED):\n\n  - Type: STRING\n  - Default: `none`\n  - Usage: `--rdi-host`\n\n  Host/IP of Write-behind Database\n\n- `rdi_port` (REQUIRED):\n\n  - Type: <IntRange 1000<=x<=65535>\n  - Default: `none`\n  - Usage: `--rdi-port`\n\n  Port of Write-behind Database\n\n- `rdi_password`:\n\n  - Type: STRING\n  - Default: `none`\n  - Usage: `--rdi-password`\n\n  Write-behind Database Password\n\n- `rdi_key`:\n\n  - Type: STRING\n  - Default: `none`\n  - Usage: `--rdi-key`\n\n  Private key file to authenticate with\n\n- `rdi_cert`:\n\n  - Type: STRING\n  - Default: `none`\n  - Usage: `--rdi-cert`\n\n  Client certificate file to authenticate with\n\n- `rdi_cacert`:\n\n  - Type: STRING\n  - Default: `none`\n  - Usage: `--rdi-cacert`\n\n  CA certificate file to verify with\n\n- `rdi_key_password`:\n\n  - Type: STRING\n  - Default: `none`\n  - Usage: `--rdi-key-password`\n\n  Password for unlocking an encrypted private key\n\n- `directory`:\n\n  - Type: STRING\n  - Default: `.`\n  - Usage: `--dir`\n\n  Directory where the support file should be generated\n\n- `dump_rejected`:\n\n  - Type: INT\n  - Default: `none`\n  - Usage: `--dump-rejected`\n\n  Dumps rejected records\n\n- `trace_timeout`:\n\n  - Type: <IntRange 1<=x<=600>\n  - Default: `none`\n  - Usage: `--trace-timeout`\n\n  Stops the trace after exceeding this timeout (in seconds)\n\n- `max_change_records`:\n\n  - Type: <IntRange x>=1>\n  - Default: `10`\n  - Usage: `--max-change-records`\n\n  Maximum traced change records per shard\n\n- `trace_only_rejected`:\n\n  - Type: BOOL\n  - Default: `false`\n  - Usage: `--trace-only-rejected`\n\n  Trace only rejected change records\n\n- `help`:\n\n  - Type: BOOL\n  - Default: `false`\n  - Usage: `--help`\n\n  Show this message and exit."
    },
    {
      "id": "cli-help",
      "title": "CLI help",
      "role": "content",
      "text": "[code example]"
    }
  ],
  "examples": [
    {
      "id": "usage-ex0",
      "language": "plaintext",
      "code": "Usage: redis-di dump-support-package [OPTIONS]",
      "section_id": "usage"
    },
    {
      "id": "cli-help-ex0",
      "language": "plaintext",
      "code": "Usage: redis-di dump-support-package [OPTIONS]\n\n  Dumps Write-behind support package\n\nOptions:\n  -log-level, --loglevel [DEBUG|INFO|WARN|ERROR|CRITICAL]\n                                  [default: INFO]\n  --rdi-host TEXT                 Host/IP of Write-behind Database  [required]\n  --rdi-port INTEGER RANGE        Port of Write-behind Database  [1000<=x<=65535;\n                                  required]\n  --rdi-password TEXT             Write-behind Database Password\n  --rdi-key TEXT                  Private key file to authenticate with\n  --rdi-cert TEXT                 Client certificate file to authenticate with\n  --rdi-cacert TEXT               CA certificate file to verify with\n  --rdi-key-password TEXT         Password for unlocking an encrypted private\n                                  key\n  --dir TEXT                      Directory where the support file should be\n                                  generated  [default: .]\n  --dump-rejected INTEGER         Dumps rejected records\n  --trace-timeout INTEGER RANGE   Stops the trace after exceeding this timeout\n                                  (in seconds)  [1<=x<=600]\n  --max-change-records INTEGER RANGE\n                                  Maximum traced change records per shard\n                                  [x>=1]\n  --trace-only-rejected           Trace only rejected change records\n  --help                          Show this message and exit.",
      "section_id": "cli-help"
    }
  ]
}
