"restore-from-file"
*******************

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


Description
===========

Restores the specified key to the specified vault, based on
information in the backup file provided. If the vault doesn’t exist,
the operation returns a response with a 404 HTTP status error code.
You need to first restore the vault associated with the key.

The top level –endpoint parameter must be supplied for this operation.


Usage
=====

   oci kms management key restore-from-file [OPTIONS]


Required Parameters
===================

--restore-key-from-file-location [text]

The file location of the encrypted payload to upload to restore the
key.


Optional Parameters
===================

--content-length [integer]

The content length of the body.

--content-md5 [text]

The base64-encoded MD5 hash value of the body, as described in RFC
2616, section 14.15. If the Content-MD5 header is present, Key
Management performs an integrity check on the body of the HTTP request
by computing the MD5 hash for the body and comparing it to the MD5
hash supplied in the header. If the two hashes don’t match, the object
is rejected and a response with 400 Unmatched Content MD5 error is
returned, along with the message: “The computed MD5 of the request
body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5).”

--from-json [text]

Provide input to this command as a JSON document from a file using the
file://path-to/file syntax.

The "--generate-full-command-json-input" option can be used to
generate a sample json file to be used with this command option. The
key names are pre-populated and match the command option names
(converted to camelCase format, e.g. compartment-id –> compartmentId),
while the values of the keys need to be populated by the user before
using the sample file as an input to this command. For any command
option that accepts multiple values, the value of the key can be a
JSON array.

Options can still be provided on the command line. If an option exists
in both the JSON document and the command line then the command line
specified value will be used.

For examples on usage of this option, please see our “using CLI with
advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--if-match [text]

For optimistic concurrency control. In the PUT or DELETE call for a
resource, set the *if-match* parameter to the value of the etag from a
previous GET or POST response for that resource. The resource will be
updated or deleted only if the etag you provide matches the resource’s
current etag value.


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
defaults-file", "--endpoint", "--generate-full-command-json-input", "
--generate-param-json-input", "--help", "--latest-version", "--max-
retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
"--output", "--profile", "--proxy", "--query", "--raw-output", "--
read-timeout", "--realm-specific-endpoint", "--region", "--release-
info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"


Example using required parameter
================================

Copy the following CLI commands into a file named example.sh. Run the
command by typing “bash example.sh” and replacing the example
parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-
like shell. You need to set up the OCI configuration and appropriate
security policies before trying the examples.

       export restore_key_from_file_location=<substitute-value-of-restore_key_from_file_location> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kms/management/key/restore-from-file.html#cmdoption-restore-key-from-file-location

       oci kms management key restore-from-file --restore-key-from-file-location $restore_key_from_file_location
