Docs Home
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
oci.Core.ConsoleHistory
Explore with Pulumi AI
This resource provides the Console History resource in Oracle Cloud Infrastructure Core service.
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.
- Use
CaptureConsoleHistoryto request the capture of up to a megabyte of the most recent console history. This call returns aConsoleHistoryobject. The object will have a state of REQUESTED. - Wait for the capture operation to succeed by polling
GetConsoleHistorywith the identifier of the console history metadata. The state of theConsoleHistoryobject will go from REQUESTED to GETTING-HISTORY and then SUCCEEDED (or FAILED). - Use
GetConsoleHistoryContentto get the actual console history data (not the metadata). - Optionally, use
DeleteConsoleHistoryto delete the console history metadata and the console history data.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testConsoleHistory = new oci.core.ConsoleHistory("test_console_history", {
instanceId: testInstance.id,
definedTags: {
"Operations.CostCenter": "42",
},
displayName: consoleHistoryDisplayName,
freeformTags: {
Department: "Finance",
},
});
import pulumi
import pulumi_oci as oci
test_console_history = oci.core.ConsoleHistory("test_console_history",
instance_id=test_instance["id"],
defined_tags={
"Operations.CostCenter": "42",
},
display_name=console_history_display_name,
freeform_tags={
"Department": "Finance",
})
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Core.NewConsoleHistory(ctx, "test_console_history", &Core.ConsoleHistoryArgs{
InstanceId: pulumi.Any(testInstance.Id),
DefinedTags: pulumi.StringMap{
"Operations.CostCenter": pulumi.String("42"),
},
DisplayName: pulumi.Any(consoleHistoryDisplayName),
FreeformTags: pulumi.StringMap{
"Department": pulumi.String("Finance"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testConsoleHistory = new Oci.Core.ConsoleHistory("test_console_history", new()
{
InstanceId = testInstance.Id,
DefinedTags =
{
{ "Operations.CostCenter", "42" },
},
DisplayName = consoleHistoryDisplayName,
FreeformTags =
{
{ "Department", "Finance" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.ConsoleHistory;
import com.pulumi.oci.Core.ConsoleHistoryArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testConsoleHistory = new ConsoleHistory("testConsoleHistory", ConsoleHistoryArgs.builder()
.instanceId(testInstance.id())
.definedTags(Map.of("Operations.CostCenter", "42"))
.displayName(consoleHistoryDisplayName)
.freeformTags(Map.of("Department", "Finance"))
.build());
}
}
resources:
testConsoleHistory:
type: oci:Core:ConsoleHistory
name: test_console_history
properties:
instanceId: ${testInstance.id}
definedTags:
Operations.CostCenter: '42'
displayName: ${consoleHistoryDisplayName}
freeformTags:
Department: Finance
Create ConsoleHistory Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ConsoleHistory(name: string, args: ConsoleHistoryArgs, opts?: CustomResourceOptions);@overload
def ConsoleHistory(resource_name: str,
args: ConsoleHistoryArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ConsoleHistory(resource_name: str,
opts: Optional[ResourceOptions] = None,
instance_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None)func NewConsoleHistory(ctx *Context, name string, args ConsoleHistoryArgs, opts ...ResourceOption) (*ConsoleHistory, error)public ConsoleHistory(string name, ConsoleHistoryArgs args, CustomResourceOptions? opts = null)
public ConsoleHistory(String name, ConsoleHistoryArgs args)
public ConsoleHistory(String name, ConsoleHistoryArgs args, CustomResourceOptions options)
type: oci:Core:ConsoleHistory
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ConsoleHistoryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ConsoleHistoryArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ConsoleHistoryArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ConsoleHistoryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ConsoleHistoryArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var consoleHistoryResource = new Oci.Core.ConsoleHistory("consoleHistoryResource", new()
{
InstanceId = "string",
DefinedTags =
{
{ "string", "string" },
},
DisplayName = "string",
FreeformTags =
{
{ "string", "string" },
},
});
example, err := Core.NewConsoleHistory(ctx, "consoleHistoryResource", &Core.ConsoleHistoryArgs{
InstanceId: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var consoleHistoryResource = new ConsoleHistory("consoleHistoryResource", ConsoleHistoryArgs.builder()
.instanceId("string")
.definedTags(Map.of("string", "string"))
.displayName("string")
.freeformTags(Map.of("string", "string"))
.build());
console_history_resource = oci.core.ConsoleHistory("consoleHistoryResource",
instance_id="string",
defined_tags={
"string": "string",
},
display_name="string",
freeform_tags={
"string": "string",
})
const consoleHistoryResource = new oci.core.ConsoleHistory("consoleHistoryResource", {
instanceId: "string",
definedTags: {
string: "string",
},
displayName: "string",
freeformTags: {
string: "string",
},
});
type: oci:Core:ConsoleHistory
properties:
definedTags:
string: string
displayName: string
freeformTags:
string: string
instanceId: string
ConsoleHistory Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ConsoleHistory resource accepts the following input properties:
- Instance
Id string The OCID of the instance to get the console history from.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) 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"}
- Instance
Id string The OCID of the instance to get the console history from.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- map[string]string
- (Updatable) 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"}
- instance
Id String The OCID of the instance to get the console history from.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Map<String,String>
- (Updatable) 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"}
- instance
Id string The OCID of the instance to get the console history from.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) 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"}
- instance_
id str The OCID of the instance to get the console history from.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - display_
name str - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) 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"}
- instance
Id String The OCID of the instance to get the console history from.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Map<String>
- (Updatable) 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"}
Outputs
All input properties are implicitly available as output properties. Additionally, the ConsoleHistory resource produces the following output properties:
- Availability
Domain string - The availability domain of an instance. Example:
Uocm:PHX-AD-1 - Compartment
Id string - The OCID of the compartment.
- Id string
- The provider-assigned unique ID for this managed resource.
- State string
- The current state of the console history.
- Time
Created string - The date and time the history was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- Availability
Domain string - The availability domain of an instance. Example:
Uocm:PHX-AD-1 - Compartment
Id string - The OCID of the compartment.
- Id string
- The provider-assigned unique ID for this managed resource.
- State string
- The current state of the console history.
- Time
Created string - The date and time the history was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- availability
Domain String - The availability domain of an instance. Example:
Uocm:PHX-AD-1 - compartment
Id String - The OCID of the compartment.
- id String
- The provider-assigned unique ID for this managed resource.
- state String
- The current state of the console history.
- time
Created String - The date and time the history was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- availability
Domain string - The availability domain of an instance. Example:
Uocm:PHX-AD-1 - compartment
Id string - The OCID of the compartment.
- id string
- The provider-assigned unique ID for this managed resource.
- state string
- The current state of the console history.
- time
Created string - The date and time the history was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- availability_
domain str - The availability domain of an instance. Example:
Uocm:PHX-AD-1 - compartment_
id str - The OCID of the compartment.
- id str
- The provider-assigned unique ID for this managed resource.
- state str
- The current state of the console history.
- time_
created str - The date and time the history was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- availability
Domain String - The availability domain of an instance. Example:
Uocm:PHX-AD-1 - compartment
Id String - The OCID of the compartment.
- id String
- The provider-assigned unique ID for this managed resource.
- state String
- The current state of the console history.
- time
Created String - The date and time the history was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
Look up Existing ConsoleHistory Resource
Get an existing ConsoleHistory resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ConsoleHistoryState, opts?: CustomResourceOptions): ConsoleHistory@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
availability_domain: Optional[str] = None,
compartment_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
instance_id: Optional[str] = None,
state: Optional[str] = None,
time_created: Optional[str] = None) -> ConsoleHistoryfunc GetConsoleHistory(ctx *Context, name string, id IDInput, state *ConsoleHistoryState, opts ...ResourceOption) (*ConsoleHistory, error)public static ConsoleHistory Get(string name, Input<string> id, ConsoleHistoryState? state, CustomResourceOptions? opts = null)public static ConsoleHistory get(String name, Output<String> id, ConsoleHistoryState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Availability
Domain string - The availability domain of an instance. Example:
Uocm:PHX-AD-1 - Compartment
Id string - The OCID of the compartment.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) 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"} - Instance
Id string The OCID of the instance to get the console history from.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- State string
- The current state of the console history.
- Time
Created string - The date and time the history was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- Availability
Domain string - The availability domain of an instance. Example:
Uocm:PHX-AD-1 - Compartment
Id string - The OCID of the compartment.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- map[string]string
- (Updatable) 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"} - Instance
Id string The OCID of the instance to get the console history from.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- State string
- The current state of the console history.
- Time
Created string - The date and time the history was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- availability
Domain String - The availability domain of an instance. Example:
Uocm:PHX-AD-1 - compartment
Id String - The OCID of the compartment.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Map<String,String>
- (Updatable) 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"} - instance
Id String The OCID of the instance to get the console history from.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- state String
- The current state of the console history.
- time
Created String - The date and time the history was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- availability
Domain string - The availability domain of an instance. Example:
Uocm:PHX-AD-1 - compartment
Id string - The OCID of the compartment.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) 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"} - instance
Id string The OCID of the instance to get the console history from.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- state string
- The current state of the console history.
- time
Created string - The date and time the history was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- availability_
domain str - The availability domain of an instance. Example:
Uocm:PHX-AD-1 - compartment_
id str - The OCID of the compartment.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - display_
name str - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) 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"} - instance_
id str The OCID of the instance to get the console history from.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- state str
- The current state of the console history.
- time_
created str - The date and time the history was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- availability
Domain String - The availability domain of an instance. Example:
Uocm:PHX-AD-1 - compartment
Id String - The OCID of the compartment.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Map<String>
- (Updatable) 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"} - instance
Id String The OCID of the instance to get the console history from.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- state String
- The current state of the console history.
- time
Created String - The date and time the history was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
Import
ConsoleHistories can be imported using the id, e.g.
$ pulumi import oci:Core/consoleHistory:ConsoleHistory test_console_history "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.