"schedule-deletion"
*******************


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

Schedules the deletion of the specified vault. This sets the state of
the vault and keys that are not scheduled deletion in it to
*PENDING_DELETION* and then deletes them after the retention period
ends. The state and the timeOfDeletion of the keys that have already
been scheduled for deletion will not change. If any keys in it are
scheduled for deletion after the specified timeOfDeletion for the
vault, the call will be rejected with status code 409.


Usage
=====

   oci kms management vault schedule-deletion [OPTIONS]


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

--vault-id [text]

The OCID of the vault.


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

--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.

--max-wait-seconds [integer]

The maximum time to wait for the resource to reach the lifecycle state
defined by "--wait-for-state". Defaults to 1200 seconds.

--time-of-deletion [datetime]

An optional property to indicate the deletion time of the vault,
expressed in RFC 3339 timestamp format. The specified time must be
between 7 and 30 days from the time when the request is received. If
this property is missing, it will be set to 30 days from the time of
the request by default.

The following datetime formats are supported:


UTC with milliseconds
---------------------

   Format: YYYY-MM-DDTHH:mm:ss.sssTZD
   Example: 2017-09-15T20:30:00.123Z


UTC without milliseconds
------------------------

   Format: YYYY-MM-DDTHH:mm:ssTZD
   Example: 2017-09-15T20:30:00Z


UTC with minute precision
-------------------------

   Format: YYYY-MM-DDTHH:mmTZD
   Example: 2017-09-15T20:30Z


Timezone with milliseconds
--------------------------

   Format: YYYY-MM-DDTHH:mm:ssTZD
   Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800


Timezone without milliseconds
-----------------------------

   Format: YYYY-MM-DDTHH:mm:ssTZD
   Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800


Timezone with minute precision
------------------------------

   Format: YYYY-MM-DDTHH:mmTZD
   Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800


Short date and time
-------------------

The timezone for this date and time will be taken as UTC (Needs to be
surrounded by single or double quotes)

   Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
   Example: '2017-09-15 17:25'


Date Only
---------

This date will be taken as midnight UTC of that day

   Format: YYYY-MM-DD
   Example: 2017-09-15


Epoch seconds
-------------

   Example: 1412195400

--wait-for-state [text]

This operation creates, modifies or deletes a resource that has a
defined lifecycle state. Specify this option to perform the action and
then wait until the resource reaches a given lifecycle state. If
timeout is reached, a return code of 2 is returned. For any other
error, a return code of 1 is returned.

Accepted values are:

   ACTIVE, CANCELLING_DELETION, CREATING, DELETED, DELETING, PENDING_DELETION, SCHEDULING_DELETION, UPDATING

--wait-interval-seconds [integer]

Check every "--wait-interval-seconds" to see whether the resource to
see if it has reached the lifecycle state defined by "--wait-for-
state". Defaults to 30 seconds.


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

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

"--auth", "--cert-bundle", "--cli-rc-file", "--config-file", "--
debug", "--defaults-file", "--endpoint", "--generate-full-command-
json-input", "--generate-param-json-input", "--help", "--no-retry", "
--opc-client-request-id", "--opc-request-id", "--output", "--profile",
"--query", "--raw-output", "--region", "--request-id", "--version",
"-?", "-d", "-h", "-v"
