capture
*******


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

Captures the most recent serial console data (up to a megabyte) for
the specified instance.

The *CaptureConsoleHistory* operation works with the other console
history operations as described below.

1. Use *CaptureConsoleHistory* to request the capture of up to a
   megabyte of the most recent console history. This call returns a
   *ConsoleHistory* object. The object will have a state of REQUESTED.
   2. Wait for the capture operation to succeed by polling
   *GetConsoleHistory* with the identifier of the console history
   metadata. The state of the *ConsoleHistory* object will go from
   REQUESTED to GETTING-HISTORY and then SUCCEEDED (or FAILED). 3. Use
   *GetConsoleHistoryContent* to get the actual console history data
   (not the metadata). 4. Optionally, use *DeleteConsoleHistory* to
   delete the console history metadata and the console history data.


Usage
=====

   oci compute console-history capture [OPTIONS]


Options
=======


--instance-id [text]
--------------------

The OCID of the instance to get the console history from. [required]


--defined-tags [complex type]
-----------------------------

Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see Resource Tags.

Example: *{"Operations": {"CostCenter": "42"}}* This is a complex type
whose value must be valid JSON. The value can be provided as a string
on the command line or passed in as a file using the
file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.


--display-name [text]
---------------------

A user-friendly name. Does not have to be unique, and it's changeable.


--freeform-tags [complex type]
------------------------------

Free-form tags for this resource. Each tag is a simple key-value pair
with no predefined name, type, or namespace. For more information, see
Resource Tags.

Example: *{"Department": "Finance"}* This is a complex type whose
value must be valid JSON. The value can be provided as a string on the
command line or passed in as a file using the file://path/to/file
syntax.

The --generate-param-json-input option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.


--wait-for-state [REQUESTED|GETTING-HISTORY|SUCCEEDED|FAILED]
-------------------------------------------------------------

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.


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


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


--from-json [text]
------------------

Provide input to this command as a JSON document from a file.

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


-?, -h, --help
--------------

Show this message and exit.
