instance_console_histories
Creates, updates, deletes, gets or lists an instance_console_histories resource.
Overview​
| Name | instance_console_histories |
| Type | Resource |
| Id | oci.compute.instance_console_histories |
Fields​
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
capture_console_history | exec | region, instanceId | opc-retry-token | Captures the most recent serial console data (up to a megabyte) for the<br />specified instance.<br /><br />The CaptureConsoleHistory operation works with the other console history operations<br />as described below.<br /><br />1. Use CaptureConsoleHistory to request the capture of up to a megabyte of the<br />most recent console history. This call returns a ConsoleHistory<br />object. The object will have a state of REQUESTED.<br />2. Wait for the capture operation to succeed by polling GetConsoleHistory with<br />the identifier of the console history metadata. The state of the<br />ConsoleHistory object will go from REQUESTED to GETTING-HISTORY and<br />then SUCCEEDED (or FAILED).<br />3. Use GetConsoleHistoryContent to get the actual console history data (not the<br />metadata).<br />4. Optionally, use DeleteConsoleHistory to delete the console history metadata<br />and the console history data.<br /> |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION) |
opc-retry-token | string | A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). |
Lifecycle Methods​
- capture_console_history
Captures the most recent serial console data (up to a megabyte) for the<br />specified instance.<br /><br />The CaptureConsoleHistory operation works with the other console history operations<br />as described below.<br /><br />1. Use CaptureConsoleHistory to request the capture of up to a megabyte of the<br />most recent console history. This call returns a ConsoleHistory<br />object. The object will have a state of REQUESTED.<br />2. Wait for the capture operation to succeed by polling GetConsoleHistory with<br />the identifier of the console history metadata. The state of the<br />ConsoleHistory object will go from REQUESTED to GETTING-HISTORY and<br />then SUCCEEDED (or FAILED).<br />3. Use GetConsoleHistoryContent to get the actual console history data (not the<br />metadata).<br />4. Optionally, use DeleteConsoleHistory to delete the console history metadata<br />and the console history data.<br />
EXEC oci.compute.instance_console_histories.capture_console_history
@region='{{ region }}' --required,
@opc-retry-token='{{ opc-retry-token }}'
@@json=
'{
"definedTags": "{{ definedTags }}",
"displayName": "{{ displayName }}",
"freeformTags": "{{ freeformTags }}",
"instanceId": "{{ instanceId }}"
}'
;