oci core image

Overview

A boot disk image for launching an instance. For more information, see Overview of the Compute Service.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

This documentation is generated from the Ruby OCI SDK.

Attributes

absent_states

The OCI states, puppet will detect as the resource being absent.

Back to overview of oci_core_image

agent_features

Back to overview of oci_core_image

base_image

The Puppet name of the resource identified by base_image_id.

See the documentation of base_image_id for all details.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_image

base_image_id

The OCID of the image originally used to launch the instance. Rather use the property base_image instead of a direct OCID reference.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_image

compartment

The Puppet name of the resource identified by compartment_id.

See the documentation of compartment_id for all details.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_image

compartment_id

The OCID of the compartment that contains the object.

Rather use the property compartment instead of a direct OCID reference.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_image

create_image_allowed

Whether instances launched with this image can be used to create new images. For example, you cannot create an image of an Oracle Database instance.

Example: true

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_image

defined_tags

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 documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_image

disable_corrective_change

Disable the modification of a resource when Puppet decides it is a corrective change.

(requires easy_type V2.11.0 or higher)

When using a Puppet Server, Puppet knows about adaptive and corrective changes. A corrective change is when Puppet notices that the resource has changed, but the catalog has not changed. This can occur for example, when a user, by accident or willingly, changed something on the system that Puppet is managing. The normal Puppet process then repairs this and puts the resource back in the state as defined in the catalog. This process is precisely what you want most of the time, but not always. This can sometimes also occur when a hardware or network error occurs. Then Puppet cannot correctly determine the current state of the system and thinks the resource is changed, while in fact, it is not. Letting Puppet recreate remove or change the resource in these cases, is NOT wat you want.

Using the disable_corrective_change parameter, you can disable corrective changes on the current resource.

Here is an example of this:

crucial_resource {'be_carefull':
  ...
  disable_corrective_change => true,
  ...
}

When a corrective ensure does happen on the resource Puppet will not modify the resource and signal an error:

    Error: Corrective change present requested by catalog, but disabled by parameter disable_corrective_change
    Error: /Stage[main]/Main/Crucial_resource[be_carefull]/parameter: change from '10' to '20' failed: Corrective change present requested by catalog, but disabled by parameter disable_corrective_change. (corrective)

Back to overview of oci_core_image

disable_corrective_ensure

Disable the creation or removal of a resource when Puppet decides is a corrective change.

(requires easy_type V2.11.0 or higher)

When using a Puppet Server, Puppet knows about adaptive and corrective changes. A corrective change is when Puppet notices that the resource has changed, but the catalog has not changed. This can occur for example, when a user, by accident or willingly, changed something on the system that Puppet is managing. The normal Puppet process then repairs this and puts the resource back in the state as defined in the catalog. This process is precisely what you want most of the time, but not always. This can sometimes also occur when a hardware or network error occurs. Then Puppet cannot correctly determine the current state of the system and thinks the resource is changed, while in fact, it is not. Letting Puppet recreate remove or change the resource in these cases, is NOT wat you want.

Using the disable_corrective_ensure parameter, you can disable corrective ensure present or ensure absent actions on the current resource.

Here is an example of this:

crucial_resource {'be_carefull':
  ensure                    => 'present',
  ...
  disable_corrective_ensure => true,
  ...
}

When a corrective ensure does happen on the resource Puppet will not create or remove the resource and signal an error:

    Error: Corrective ensure present requested by catalog, but disabled by parameter disable_corrective_ensure.
    Error: /Stage[main]/Main/Crucial_resource[be_carefull]/ensure: change from 'absent' to 'present' failed: Corrective ensure present requested by catalog, but disabled by parameter disable_corrective_ensure. (corrective)

Back to overview of oci_core_image

ensure

The basic property that the resource should be in.

Valid values are present, absent.

Back to overview of oci_core_image

freeform_tags

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 documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_image

id

The OCID of the resource. This is a read-only property.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_image

image_name

The name of the image.

Back to overview of oci_core_image

image_source_details

Details for creating an image through import

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_image

instance

The Puppet name of the resource identified by instance_id.

See the documentation of instance_id for all details.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_image

instance_id

The OCID of the instance you want to use as the basis for the image. Rather use the property instance instead of a direct OCID reference.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_image

launch_mode

Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:

• NATIVE - VM instances launch with paravirtualized boot and VFIO devices. The default value for Oracle-provided images.
• EMULATED - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
• PARAVIRTUALIZED - VM instances launch with paravirtualized devices using virtio drivers.

• CUSTOM - VM instances launch with custom configuration settings specified in the LaunchOptions parameter.

  This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_image

launch_options

Back to overview of oci_core_image

lifecycle_state

This attribute is required.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_image

name

The full name of the object.

Back to overview of oci_core_image

oci_timeout

The maximum time to wait for the OCI resource to be in the ready state.

Back to overview of oci_core_image

oci_wait_interval

The interval beween calls to OCI to check if a resource is in the ready state.

Back to overview of oci_core_image

operating_system

The image’s operating system.

Example: Oracle Linux

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_image

operating_system_version

The image’s operating system version.

Example: 7.2

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_image

present_states

The OCI states, puppet will detect as the resource being present.

Back to overview of oci_core_image

provider

The specific backend to use for this oci_core_image resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.Available providers are:

sdk

This provider uses the Oracle Ruby OCI SDK to do its work.

Back to overview of oci_core_image

size_in_mbs

The boot volume size for an instance launched from this image, (1 MB = 1048576 bytes). Note this is not the same as the size of the image when it was exported or the actual size of the image.

Example: 47694

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_image

synchronized

Specifies if Puppet waits for OCI actions to be ready before moving on to an other resource.

Back to overview of oci_core_image

tenant

The tenant for this resource.

Back to overview of oci_core_image

time_created

The date and time the image was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_image