`oadp tenant-restore create`

Restore a backup of an IBM Software Hub instance.

Syntax

cpd-cli oadp tenant-restore create <tenant-restore-name> \
--from-tenant-backup=<tenant-backup-file-name> \
[--aux-service-image-prefix=<backup-hook-image-prefix>] \
[--cacert=<certificate-bundle-path>] \
[--disable-inverseops=true|false] \
[--help \
[--image-prefix=<image-registry-prefix>] \
[--insecure-skip-tls-verify=true|false] \
[--posthooks=true|false] \
[--preworkloadhooks=true|false] \
[--retries=<integer>] \
[--scale-wait-timeout=<h,m,s>] \
[--skip-hooks] \
[--skip-no-plan-meta]=true|false] \
[--uploader-type=kopia|restic] \
[--values=<yaml-file-name1,yaml-file-name2,...>] \

# Global options
[--add_dir_header=true|false] \
[--alsologtostderr=true|false] \
[--cpd-namespace=<cpd-namespace>] \
[--kubeconfig=<kubeconfig-paths> \
[--log-level=info|debug|warn|error|panic|trace] \
[--log-backtrace-at traceLocation=<integer>] \
[--log-dir=<log_directory>] \
[--log-file=<log_file_name>] \
[--log_file_max_size=<uint>] \
[--logtostderr=true|false] \
[--namespace=<namespace-name>] \
[--one-output=true|false] \
[--skip-headers=true|false] \
[--skip-log-headers=true|false] \
[--stderrthreshold severity=<integer>] \
[--v=<integer>] \
[--verbose \
[--vmodule moduleSpec=<pattern1, pattern2, and so on>]

Arguments

Table 1: Command arguments

Argument	Description
`<tenant-restore-name>`	The name of the restore to create.

Table 2: Global options arguments

Argument	Description
`<trace-location>`	The stack trace location
`<severity>`	The log severity level

Options

Table 1: Command options

Option	Description
`--aux-service-image-prefix`	Specify the backup hook job image prefix (if configurable). Status Optional. Syntax `--aux-service-image-prefix=<backup-hook-image-prefix>` Default value `icr.io/cpopen/cpd` Valid values `icr.io/cpopen/cpd` `${PRIVATE_REGISTRY_LOCATION}`
`--cacert`	The certificate bundle path to use when verifying TLS connections. Status Optional. Syntax `--cacert=<certificate-bundle-path>` Default value No default. Valid values A valid certificate bundle path.
`--disable-inverseops`	Disable inverseops upon a fatal plan execution error. Status Optional. Syntax `--disable-inverseops` Default value `true` Valid values `false` Does not disable inverseops. `true` Disables inverseops.
`--force`	If true, allows the target namespaces to exist. Status Optional. Syntax `--force=true\|false` Default value `false` Valid values `true\|false`
`--from-tenant-backup` `--b`	The tenant backup name from which to restore. Status Mandatory. Syntax `--from-tenant-backup=<tenant-backup-file-name>` Default value No default. Valid values A valid backup file name.
`--help` `-h`	Display command help. Status Optional. Syntax `--help` Default value No default. Valid values Not applicable.
`--image-prefix`	Specify the image registry prefix. Status Optional. Syntax `--image-prefix=<image-registry-prefix>` Default value `registry.redhat.io/ubi9` Valid values icr.io/cpopen/cpd registry.redhat.io/ubi9 ${PRIVATE_REGISTRY_LOCATION}
`--insecure-skip-tls-verify`	When set to 'true', the object store's TLS certificate are not checked for validity (not recommended for production). Status Optional. Syntax `--insecure-skip-tls-verify=true\|false` Default value `false` Valid values `false` The object store's TLS certificate are not checked for validity. `true` When set to 'true', the object store's TLS certificate are not checked for validity (not recommended for production).
`--posthooks`	Run ConfigMap post-restore hooks. Status Optional. Syntax `--posthooks=true\|false` Default value `true` Valid values `true` Run ConfigMap post-restore hooks. `false` Do not run ConfigMap post-restore hooks.
`--precheck-exclude-checks`	Comma separated list of backup precheck checks to skip. Status Optional. Syntax `--precheck-exclude-checks=[<precheck1_name>,<precheck2_name>...]` Default value `No default.` Valid values stringArray `CheckOadpOperatorCSV`, `CheckVeleroInstanceHealth`, `CheckBSLAvailability`, `CheckDPAVeleroPlugin`, `CheckBackupWarningError`, `CheckBackupNamespaces`, `CheckIBMCommonServiceValidatingWebhook`
`--precheck-ignore-warnings`	Specifies whether backup precheck warnings will not be flagged as errors. Status Optional. Syntax `--precheck-ignore-warnings=true\|false` Default value `true` Valid values `true` Precheck warnings are flagged as errors. `false` Precheck warnings are not flagged as errors.
`--precheck-include-checks`	Comma separated list of backup precheck checks to selectively run. By default, all checks are executed if this option is not specified. Status Optional. Syntax `--precheck-include-checks=[<precheck1_name>,<precheck2_name>...]` Default value `No default.` Valid values stringArray `CheckOadpOperatorCSV`, `CheckVeleroInstanceHealth`, `CheckBSLAvailability`, `CheckDPAVeleroPlugin`, `CheckBackupWarningError`, `CheckBackupNamespaces`, `CheckIBMCommonServiceValidatingWebhook`
`--preworkloadhooks`	Run the ConfigMap pre-workload restore hooks. Status Optional. Syntax `--preworkloadhooks=true\|false` Default value `true` Valid values `true` Run the ConfigMap pre-workload restore hooks. `false` Do not run the ConfigMap pre-workload restore hooks.
`--retries`	Number of retries if a restore step fails. Status Optional. Syntax `--retries=<integer>` Default value `0` Valid values Plain integer
`--scale-wait-timeout`	The scale wait timeout duration ('h' for hours, 'm' for minutes, 's' for seconds). Status Optional. Syntax `--scale-wait-timeout=<h,m,s>` Default value `30m0s` Valid values Any valid duration string. Examples: 1m, 30m, 1h, 2h45m
`--skip-hooks`	Skip the default scale up of Kubernetes resources and ConfigMap restore hooks. Status Optional. Syntax `--skip-hooks` Default value No default Valid values Not applicable.
`--skip-no-plan-meta`	If true, skip ConfigMaps that do not have a plan-meta section. Otherwise, report an error if a ConfigMap does not have a plan-meta section. Status Optional. Syntax `--skip-no-plan-meta` Default value true Valid values Not applicable.
`--skip-precheck`	Skip precheck hooks. Status Optional. Syntax `--skip-precheck` Default value No default. Valid values Not applicable.
`--uploader-type`	The type of uploader used to transfer pod volume data. Status Optional. Syntax `--uploader-type=kopia\|restic` Default value `kopia` Valid values kopia\|restic
`--values` `-f`	YAML files containing custom parameters to be passed to ConfigMap hooks. Status Optional. Syntax `--values=<yaml-file-name1,yaml-file-name2,...>` Default value No default. Valid values One or more YAML file names.

Global options

You can also use the following global options with this command:

Table 2: Command global options

Option	Description
`--add_dir_header`	Add the file directory to the header of log messages. Status Optional. Syntax `--add_dir_header=true\|false` Default value false Valid values `false` Do not add the file directory to the header of log messages. `true` Add the file directory to the header of log messages.
`--alsologtostderr`	Log to standard error as well as files. Status Optional. Syntax `--alsologtostderr=true\|false` Default value false Valid values `false` Do not log to standard error as well as files. `true` Log to standard error as well as files. Note: This option has no effect when `--logtostderr=true`.
`--cpd-namespace`	The IBM Software Hub namespace in which the utility operates. Status Optional. Syntax `--cpd-namespace=<cpd-namespace>` Default value No default value. Valid values A valid IBM® Software Hub namespace. Tip: The following command is an alternative to using this option: `cpd-cli oadp client config set cpd-namespace=<cpd-namespace-name>` However, the option takes precedence over the command.
`--kubeconfig`	Paths to a kubeconfig. Only required if out-of-cluster. Status Optional. Syntax `--kubeconfig=<kubeconfig-paths>` Default value No default. Valid values Valid kubeconfig paths.
`--log-level`	The command log level. Status Optional. Syntax `--log-level=info\|debug\|warn\|error\|panic\|trace` Default value `info` Valid values `debug` Debug messages are written to the log. `error` Error messages are written to the log. `info` Informative messages are written to the log. `panic` Panic messages are written to the log. `warn` Warning messages are written to the log.
`--log-backtrace-at traceLocation`	When logging hits line file:N, emit a stack trace. Status Optional. Syntax `--log-backtrace-at traceLocation=<integer>` Default value `0.` Valid values Any positive integer.
`--log-dir`	If non-empty, write log files in this directory. Status Optional. Syntax `--log-dir=<log_directory>` Default value `No default.` Valid values A valid directory. Note: This option has no effect when `--logtostderr=true`.
`--log-file`	If non-empty, use this log file. Status Optional. Syntax `--log-file=<log_file_name>` Default value `No default.` Valid values A valid directory. Note: This option has no effect when `--logtostderr=true`.
`--log_file_max_size`	The maximum size, in MB, that a log file can grow to. If you specify 0, the maximum file size is unlimited. Status Optional. Syntax `--log_file_max_size=<uint>` Default value `1800.` Valid values A valid unsigned integer. Note: This option has no effect when `--logtostderr=true`.
`--logtostderr`	Log to standard error instead of files. Status Optional. Syntax `--logtostderr=true\|false` Default value `true` Valid values `true` Log to standard error instead of files. `false` Log to files.
`--namespace` `-n`	The namespace where OADP is installed. Status Optional. Syntax `--namespace=<oadp-namespace>` Default value No default value. Valid values Valid namespace name. Tip: The following command is an alternative to using this option: `cpd-cli oadp client config set namespace=<OADP-operator-namespace>` However, the option takes precedence over the command.
`--one-output`	Specifies whether to only write logs to their native severity level. Status Optional. Syntax `--one-output=true\|false` Default value `false` Valid values `false` Write logs to their native severity level and also to each lower severity level. `true` Write logs only to their native severity level. Note: This option has no effect when `--logtostderr=true`.
`--skip-headers`	Specifies whether to avoid header prefixes in log messages. Status Optional. Syntax `--skip-headers` Default value false Valid values `false` Do not avoid header prefixes in log messages. `true` Avoid header prefixes in log messages.
`--skip-log-headers`	Specifies whether to avoid header prefixes when opening log files. Status Optional. Syntax `--skip-log-headers` Default value false Valid values `false` Do not avoid headers when opening log files. `true` Avoid headers when opening log files. Note: This option has no effect when `--logtostderr=true`.
`--stderrthreshold severity`	Logs at or above the specified threshold. Go to stderr when writing to files and stderr. Status Optional. Syntax `--stderrthreshold severity=<integer>` Default value 2 Valid values Any positive integer. Note: This option has no effect when `--logtostderr=true` or .`--alsologtostderr=false`
`--v` `-v`	Number for the log level verbosity. Status Optional. Syntax `--v=<integer>` Default value `No default.` Valid values Any valid positive integer.
`--verbose`	Logs include more detailed messages. Status Optional. Syntax `--verbose` Default value No default. Valid values Not applicable.
`--vmodule moduleSpec`	Comma-separated list of pattern=N settings for file-filtered logging. Status Optional. Syntax `--vmodule moduleSpec=<pattern1, pattern2, and so on>` Default value `No default.` Valid values

Example

Note: The following examples use the recommended installation environment variables.

It is strongly recommended that you use a script to create environment variables with the correct values for your environment. For more information, see Setting up installation environment variables.

Restore a backup of an IBM Cloud Pak for Data instance (<tenant-backup-name>) in an air-gapped environment.

cpd-cli oadp tenant-restore create <tenant-restore-name> \
--from-tenant-backup ${TENANT_BACKUP_NAME}\
--image-prefix=${PRIVATE_REGISTRY_LOCATION} \
--log-level=debug \
--verbose