Reference for gpbackup_ddboost_plugin, the DD Boost storage plugin for gpbackup and gprestore. For a task-based walkthrough of installing, configuring, and using the plugin, see Backing up to Dell Data Domain.
Configuration options
Connection
| Option | Default | Description |
|---|---|---|
executablepath | Required. Absolute path to the plugin binary. | |
hostname | Required. The Data Domain appliance to connect to. | |
username | Required. The DD Boost account username. | |
password | Required. The DD Boost account password. Stored in cleartext when password_encryption is off. | |
password_encryption | off | Only off is supported. Setting on returns a configuration error rather than encrypting the password. |
storage_unit | Required. The Data Domain storage unit to use, the logical container a DD Boost user writes data into, backed by its own mtree on the appliance. Must already exist. | |
directory | Required. The base path for backups within the storage unit. gpbackup creates it automatically on backup, so it doesn't need to exist beforehand. |
Selective restore
| Option | Default | Description |
|---|---|---|
restore_subset | on | Enables gprestore to restore a subset of tables from a single-data-file backup without reading the entire backup set. Set to "off" to disable it. |
Security
| Option | Default | Description |
|---|---|---|
use_tls | off | Enables TLS for the connection to the appliance. |
tls_auth_mode | Required when use_tls is "on". One of one_way, two_way, anon, or psk. | |
tls_encr_strength | high | med or high. |
tls_server_ca_file | Required for one_way and two_way authentication modes. | |
tls_client_cert | Required for two_way authentication mode. | |
tls_client_key | Required for two_way authentication mode. | |
tls_client_chain_file | Optional, and only used with two_way authentication mode. |
Connection version and IP family
| Option | Default | Description |
|---|---|---|
connect_config_version | v1 | v1 or v6. v6 is required to set server_port, and isn't supported on single-node or single-server Data Domain appliances. |
server_port | A non-default DD Boost port. Requires connect_config_version set to "v6". | |
ip_family | SDK default | v4prefer, v6prefer, or noprefer. |
Timeouts and retries
| Option | Default | Description |
|---|---|---|
sdk_operation_timeout_seconds | 300 | Bounds a single DD Boost operation, including its retries. 0 disables it. Values from 1 to 59 are rejected. |
retry_max_attempts | 3 | From 1 to 10. |
retry_initial_delay_ms | 500 | From 1 to 60000. |
retry_max_delay_ms | 5000 | From 1 to 300000. Must be greater than or equal to retry_initial_delay_ms. |
retry_busy_factor | 4 | From 1 to 20. Multiplies the retry delay for appliance-busy or stream-limit errors. |
Commands
gpbackup and gprestore invoke most of the plugin's commands internally, for example backup_file, restore_file, and delete_backup. These commands aren't meant to be run directly. The commands in this table are the exception:
| Command | Syntax | Description |
|---|---|---|
--version | gpbackup_ddboost_plugin --version | Prints the plugin's own version. |
plugin_api_version | gpbackup_ddboost_plugin plugin_api_version | Prints the gpbackup plugin API version the plugin implements. |