console_histories

Creates, updates, deletes, gets or lists a console_histories resource.

Overview

Name	console_histories
Type	Resource
Id	oci.compute.console_histories

Fields

The following fields are returned by SELECT queries:

get

Console history metadata

Name	Datatype	Description
id	string	The OCID of the console history metadata object.
availabilityDomain	string	The availability domain of an instance. Example: Uocm:PHX-AD-1
compartmentId	string	The OCID of the compartment.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
displayName	string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags	object	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](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
instanceId	string	The OCID of the instance this console history was fetched from.
lifecycleState	string	The current state of the console history. (REQUESTED, GETTING-HISTORY, SUCCEEDED, FAILED)
timeCreated	string (date-time)	The date and time the history was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z

list

An instance's serial console data. It includes configuration messages that occur when the<br />instance boots, such as kernel and BIOS messages, and is useful for checking the status of<br />the instance or diagnosing problems. The console data is minimally formatted ASCII text.<br /><br />Warning: Oracle recommends that you avoid using any confidential information when you<br />supply string values using the API.<br />

Name	Datatype	Description
id	string	The OCID of the console history metadata object.
availabilityDomain	string	The availability domain of an instance. Example: Uocm:PHX-AD-1
compartmentId	string	The OCID of the compartment.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
displayName	string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags	object	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](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
instanceId	string	The OCID of the instance this console history was fetched from.
lifecycleState	string	The current state of the console history. (REQUESTED, GETTING-HISTORY, SUCCEEDED, FAILED)
timeCreated	string (date-time)	The date and time the history was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	instanceConsoleHistoryId, region		Shows the metadata for the specified console history.<br />See [CaptureConsoleHistory](#/en/iaas/latest/ConsoleHistory/CaptureConsoleHistory)<br />for details about using the console history operations.<br />
list	select	compartmentId, region	availabilityDomain, limit, page, instanceId, sortBy, sortOrder, lifecycleState	Lists the console history metadata for the specified compartment or instance.<br />
update	update	instanceConsoleHistoryId, region	if-match	Updates the specified console history metadata.
delete	delete	instanceConsoleHistoryId, region	if-match	Deletes the specified console history metadata 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
compartmentId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
instanceConsoleHistoryId	string	The OCID of the console history.
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)
availabilityDomain	string	The name of the availability domain. Example: Uocm:PHX-AD-1
if-match	string	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.
instanceId	string	The OCID of the instance.
lifecycleState	string	A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
limit	integer	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: 50
page	string	For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
sortBy	string	The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.
sortOrder	string	The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

SELECT examples

get

Shows the metadata for the specified console history.<br />See [CaptureConsoleHistory](#/en/iaas/latest/ConsoleHistory/CaptureConsoleHistory)<br />for details about using the console history operations.<br />

SELECT
id,
availabilityDomain,
compartmentId,
definedTags,
displayName,
freeformTags,
instanceId,
lifecycleState,
timeCreated
FROM oci.compute.console_histories
WHERE instanceConsoleHistoryId = '{{ instanceConsoleHistoryId }}' -- required
AND region = '{{ region }}' -- required
;

list

Lists the console history metadata for the specified compartment or instance.<br />

SELECT
id,
availabilityDomain,
compartmentId,
definedTags,
displayName,
freeformTags,
instanceId,
lifecycleState,
timeCreated
FROM oci.compute.console_histories
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND availabilityDomain = '{{ availabilityDomain }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND instanceId = '{{ instanceId }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
;

UPDATE examples

update

Updates the specified console history metadata.

UPDATE oci.compute.console_histories
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}'
WHERE 
instanceConsoleHistoryId = '{{ instanceConsoleHistoryId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
RETURNING
id,
availabilityDomain,
compartmentId,
definedTags,
displayName,
freeformTags,
instanceId,
lifecycleState,
timeCreated;

DELETE examples

delete

Deletes the specified console history metadata and the console history data.<br />

DELETE FROM oci.compute.console_histories
WHERE instanceConsoleHistoryId = '{{ instanceConsoleHistoryId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
;