1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. getImages
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.Core.getImages

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

    This data source provides the list of Images in Oracle Cloud Infrastructure Core service.

    Lists a subset of images available in the specified compartment, including platform images and custom images. The list of platform images includes the three most recently published versions of each major distribution. The list does not support filtering based on image tags.

    The list of images returned is ordered to first show the recent platform images, then all of the custom images.

    Caution: Platform images are refreshed regularly. When new images are released, older versions are replaced. The image OCIDs remain available, but when the platform image is replaced, the image OCIDs are no longer returned as part of the platform image list.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testImages = oci.Core.getImages({
        compartmentId: compartmentId,
        displayName: imageDisplayName,
        operatingSystem: imageOperatingSystem,
        operatingSystemVersion: imageOperatingSystemVersion,
        shape: imageShape,
        state: imageState,
        sortBy: imageSortBy,
        sortOrder: imageSortOrder,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_images = oci.Core.get_images(compartment_id=compartment_id,
        display_name=image_display_name,
        operating_system=image_operating_system,
        operating_system_version=image_operating_system_version,
        shape=image_shape,
        state=image_state,
        sort_by=image_sort_by,
        sort_order=image_sort_order)
    
    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.GetImages(ctx, &core.GetImagesArgs{
    			CompartmentId:          compartmentId,
    			DisplayName:            pulumi.StringRef(imageDisplayName),
    			OperatingSystem:        pulumi.StringRef(imageOperatingSystem),
    			OperatingSystemVersion: pulumi.StringRef(imageOperatingSystemVersion),
    			Shape:                  pulumi.StringRef(imageShape),
    			State:                  pulumi.StringRef(imageState),
    			SortBy:                 pulumi.StringRef(imageSortBy),
    			SortOrder:              pulumi.StringRef(imageSortOrder),
    		}, nil)
    		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 testImages = Oci.Core.GetImages.Invoke(new()
        {
            CompartmentId = compartmentId,
            DisplayName = imageDisplayName,
            OperatingSystem = imageOperatingSystem,
            OperatingSystemVersion = imageOperatingSystemVersion,
            Shape = imageShape,
            State = imageState,
            SortBy = imageSortBy,
            SortOrder = imageSortOrder,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Core.CoreFunctions;
    import com.pulumi.oci.Core.inputs.GetImagesArgs;
    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) {
            final var testImages = CoreFunctions.getImages(GetImagesArgs.builder()
                .compartmentId(compartmentId)
                .displayName(imageDisplayName)
                .operatingSystem(imageOperatingSystem)
                .operatingSystemVersion(imageOperatingSystemVersion)
                .shape(imageShape)
                .state(imageState)
                .sortBy(imageSortBy)
                .sortOrder(imageSortOrder)
                .build());
    
        }
    }
    
    variables:
      testImages:
        fn::invoke:
          Function: oci:Core:getImages
          Arguments:
            compartmentId: ${compartmentId}
            displayName: ${imageDisplayName}
            operatingSystem: ${imageOperatingSystem}
            operatingSystemVersion: ${imageOperatingSystemVersion}
            shape: ${imageShape}
            state: ${imageState}
            sortBy: ${imageSortBy}
            sortOrder: ${imageSortOrder}
    

    Using getImages

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getImages(args: GetImagesArgs, opts?: InvokeOptions): Promise<GetImagesResult>
    function getImagesOutput(args: GetImagesOutputArgs, opts?: InvokeOptions): Output<GetImagesResult>
    def get_images(compartment_id: Optional[str] = None,
                   display_name: Optional[str] = None,
                   filters: Optional[Sequence[_core.GetImagesFilter]] = None,
                   operating_system: Optional[str] = None,
                   operating_system_version: Optional[str] = None,
                   shape: Optional[str] = None,
                   sort_by: Optional[str] = None,
                   sort_order: Optional[str] = None,
                   state: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetImagesResult
    def get_images_output(compartment_id: Optional[pulumi.Input[str]] = None,
                   display_name: Optional[pulumi.Input[str]] = None,
                   filters: Optional[pulumi.Input[Sequence[pulumi.Input[_core.GetImagesFilterArgs]]]] = None,
                   operating_system: Optional[pulumi.Input[str]] = None,
                   operating_system_version: Optional[pulumi.Input[str]] = None,
                   shape: Optional[pulumi.Input[str]] = None,
                   sort_by: Optional[pulumi.Input[str]] = None,
                   sort_order: Optional[pulumi.Input[str]] = None,
                   state: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetImagesResult]
    func GetImages(ctx *Context, args *GetImagesArgs, opts ...InvokeOption) (*GetImagesResult, error)
    func GetImagesOutput(ctx *Context, args *GetImagesOutputArgs, opts ...InvokeOption) GetImagesResultOutput

    > Note: This function is named GetImages in the Go SDK.

    public static class GetImages 
    {
        public static Task<GetImagesResult> InvokeAsync(GetImagesArgs args, InvokeOptions? opts = null)
        public static Output<GetImagesResult> Invoke(GetImagesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetImagesResult> getImages(GetImagesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Core/getImages:getImages
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters List<GetImagesFilter>
    OperatingSystem string
    The image's operating system. Example: Oracle Linux
    OperatingSystemVersion string
    The image's operating system version. Example: 7.2
    Shape string
    Shape name.
    SortBy string
    Sort the resources returned, by creation time or display name. Example TIMECREATED or DISPLAYNAME.
    SortOrder string
    The sort order to use, either ascending (ASC) or descending (DESC).
    State string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters []GetImagesFilter
    OperatingSystem string
    The image's operating system. Example: Oracle Linux
    OperatingSystemVersion string
    The image's operating system version. Example: 7.2
    Shape string
    Shape name.
    SortBy string
    Sort the resources returned, by creation time or display name. Example TIMECREATED or DISPLAYNAME.
    SortOrder string
    The sort order to use, either ascending (ASC) or descending (DESC).
    State string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    compartmentId String
    The OCID of the compartment.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<GetImagesFilter>
    operatingSystem String
    The image's operating system. Example: Oracle Linux
    operatingSystemVersion String
    The image's operating system version. Example: 7.2
    shape String
    Shape name.
    sortBy String
    Sort the resources returned, by creation time or display name. Example TIMECREATED or DISPLAYNAME.
    sortOrder String
    The sort order to use, either ascending (ASC) or descending (DESC).
    state String
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    compartmentId string
    The OCID of the compartment.
    displayName string
    A filter to return only resources that match the given display name exactly.
    filters GetImagesFilter[]
    operatingSystem string
    The image's operating system. Example: Oracle Linux
    operatingSystemVersion string
    The image's operating system version. Example: 7.2
    shape string
    Shape name.
    sortBy string
    Sort the resources returned, by creation time or display name. Example TIMECREATED or DISPLAYNAME.
    sortOrder string
    The sort order to use, either ascending (ASC) or descending (DESC).
    state string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    compartment_id str
    The OCID of the compartment.
    display_name str
    A filter to return only resources that match the given display name exactly.
    filters Sequence[core.GetImagesFilter]
    operating_system str
    The image's operating system. Example: Oracle Linux
    operating_system_version str
    The image's operating system version. Example: 7.2
    shape str
    Shape name.
    sort_by str
    Sort the resources returned, by creation time or display name. Example TIMECREATED or DISPLAYNAME.
    sort_order str
    The sort order to use, either ascending (ASC) or descending (DESC).
    state str
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    compartmentId String
    The OCID of the compartment.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<Property Map>
    operatingSystem String
    The image's operating system. Example: Oracle Linux
    operatingSystemVersion String
    The image's operating system version. Example: 7.2
    shape String
    Shape name.
    sortBy String
    Sort the resources returned, by creation time or display name. Example TIMECREATED or DISPLAYNAME.
    sortOrder String
    The sort order to use, either ascending (ASC) or descending (DESC).
    state String
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    getImages Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment containing the instance you want to use as the basis for the image.
    Id string
    The provider-assigned unique ID for this managed resource.
    Images List<GetImagesImage>
    The list of images.
    DisplayName string
    A user-friendly name for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    Filters List<GetImagesFilter>
    OperatingSystem string
    The image's operating system. Example: Oracle Linux
    OperatingSystemVersion string
    The image's operating system version. Example: 7.2
    Shape string
    SortBy string
    SortOrder string
    State string
    The current state of the image.
    CompartmentId string
    The OCID of the compartment containing the instance you want to use as the basis for the image.
    Id string
    The provider-assigned unique ID for this managed resource.
    Images []GetImagesImage
    The list of images.
    DisplayName string
    A user-friendly name for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    Filters []GetImagesFilter
    OperatingSystem string
    The image's operating system. Example: Oracle Linux
    OperatingSystemVersion string
    The image's operating system version. Example: 7.2
    Shape string
    SortBy string
    SortOrder string
    State string
    The current state of the image.
    compartmentId String
    The OCID of the compartment containing the instance you want to use as the basis for the image.
    id String
    The provider-assigned unique ID for this managed resource.
    images List<GetImagesImage>
    The list of images.
    displayName String
    A user-friendly name for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters List<GetImagesFilter>
    operatingSystem String
    The image's operating system. Example: Oracle Linux
    operatingSystemVersion String
    The image's operating system version. Example: 7.2
    shape String
    sortBy String
    sortOrder String
    state String
    The current state of the image.
    compartmentId string
    The OCID of the compartment containing the instance you want to use as the basis for the image.
    id string
    The provider-assigned unique ID for this managed resource.
    images GetImagesImage[]
    The list of images.
    displayName string
    A user-friendly name for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters GetImagesFilter[]
    operatingSystem string
    The image's operating system. Example: Oracle Linux
    operatingSystemVersion string
    The image's operating system version. Example: 7.2
    shape string
    sortBy string
    sortOrder string
    state string
    The current state of the image.
    compartment_id str
    The OCID of the compartment containing the instance you want to use as the basis for the image.
    id str
    The provider-assigned unique ID for this managed resource.
    images Sequence[core.GetImagesImage]
    The list of images.
    display_name str
    A user-friendly name for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters Sequence[core.GetImagesFilter]
    operating_system str
    The image's operating system. Example: Oracle Linux
    operating_system_version str
    The image's operating system version. Example: 7.2
    shape str
    sort_by str
    sort_order str
    state str
    The current state of the image.
    compartmentId String
    The OCID of the compartment containing the instance you want to use as the basis for the image.
    id String
    The provider-assigned unique ID for this managed resource.
    images List<Property Map>
    The list of images.
    displayName String
    A user-friendly name for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters List<Property Map>
    operatingSystem String
    The image's operating system. Example: Oracle Linux
    operatingSystemVersion String
    The image's operating system version. Example: 7.2
    shape String
    sortBy String
    sortOrder String
    state String
    The current state of the image.

    Supporting Types

    GetImagesFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    GetImagesImage

    AgentFeatures List<GetImagesImageAgentFeature>
    Oracle Cloud Agent features supported on the image.
    BaseImageId string
    The OCID of the image originally used to launch the instance.
    BillableSizeInGbs string
    The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: 100
    CompartmentId string
    The OCID of the compartment.
    CreateImageAllowed bool
    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
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    FreeformTags Dictionary<string, string>
    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"}
    Id string
    The OCID of the image.
    ImageSourceDetails List<GetImagesImageImageSourceDetail>
    InstanceId string
    LaunchMode string
    Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:

    • NATIVE - VM instances launch with iSCSI boot and VFIO devices. The default value for platform 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.
    LaunchOptions List<GetImagesImageLaunchOption>
    Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
    ListingType string
    The listing type of the image. The default value is "NONE".
    OperatingSystem string
    The image's operating system. Example: Oracle Linux
    OperatingSystemVersion string
    The image's operating system version. Example: 7.2
    SizeInMbs string
    The boot volume size for an instance launched from this image (1 MB = 1,048,576 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
    State string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    TimeCreated string
    The date and time the image was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    AgentFeatures []GetImagesImageAgentFeature
    Oracle Cloud Agent features supported on the image.
    BaseImageId string
    The OCID of the image originally used to launch the instance.
    BillableSizeInGbs string
    The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: 100
    CompartmentId string
    The OCID of the compartment.
    CreateImageAllowed bool
    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
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    FreeformTags map[string]string
    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"}
    Id string
    The OCID of the image.
    ImageSourceDetails []GetImagesImageImageSourceDetail
    InstanceId string
    LaunchMode string
    Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:

    • NATIVE - VM instances launch with iSCSI boot and VFIO devices. The default value for platform 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.
    LaunchOptions []GetImagesImageLaunchOption
    Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
    ListingType string
    The listing type of the image. The default value is "NONE".
    OperatingSystem string
    The image's operating system. Example: Oracle Linux
    OperatingSystemVersion string
    The image's operating system version. Example: 7.2
    SizeInMbs string
    The boot volume size for an instance launched from this image (1 MB = 1,048,576 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
    State string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    TimeCreated string
    The date and time the image was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    agentFeatures List<GetImagesImageAgentFeature>
    Oracle Cloud Agent features supported on the image.
    baseImageId String
    The OCID of the image originally used to launch the instance.
    billableSizeInGbs String
    The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: 100
    compartmentId String
    The OCID of the compartment.
    createImageAllowed Boolean
    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
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    A filter to return only resources that match the given display name exactly.
    freeformTags Map<String,String>
    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"}
    id String
    The OCID of the image.
    imageSourceDetails List<GetImagesImageImageSourceDetail>
    instanceId String
    launchMode String
    Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:

    • NATIVE - VM instances launch with iSCSI boot and VFIO devices. The default value for platform 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.
    launchOptions List<GetImagesImageLaunchOption>
    Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
    listingType String
    The listing type of the image. The default value is "NONE".
    operatingSystem String
    The image's operating system. Example: Oracle Linux
    operatingSystemVersion String
    The image's operating system version. Example: 7.2
    sizeInMbs String
    The boot volume size for an instance launched from this image (1 MB = 1,048,576 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
    state String
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    timeCreated String
    The date and time the image was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    agentFeatures GetImagesImageAgentFeature[]
    Oracle Cloud Agent features supported on the image.
    baseImageId string
    The OCID of the image originally used to launch the instance.
    billableSizeInGbs string
    The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: 100
    compartmentId string
    The OCID of the compartment.
    createImageAllowed boolean
    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
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    A filter to return only resources that match the given display name exactly.
    freeformTags {[key: string]: string}
    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"}
    id string
    The OCID of the image.
    imageSourceDetails GetImagesImageImageSourceDetail[]
    instanceId string
    launchMode string
    Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:

    • NATIVE - VM instances launch with iSCSI boot and VFIO devices. The default value for platform 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.
    launchOptions GetImagesImageLaunchOption[]
    Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
    listingType string
    The listing type of the image. The default value is "NONE".
    operatingSystem string
    The image's operating system. Example: Oracle Linux
    operatingSystemVersion string
    The image's operating system version. Example: 7.2
    sizeInMbs string
    The boot volume size for an instance launched from this image (1 MB = 1,048,576 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
    state string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    timeCreated string
    The date and time the image was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    agent_features Sequence[core.GetImagesImageAgentFeature]
    Oracle Cloud Agent features supported on the image.
    base_image_id str
    The OCID of the image originally used to launch the instance.
    billable_size_in_gbs str
    The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: 100
    compartment_id str
    The OCID of the compartment.
    create_image_allowed bool
    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
    defined_tags Mapping[str, str]
    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
    A filter to return only resources that match the given display name exactly.
    freeform_tags Mapping[str, str]
    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"}
    id str
    The OCID of the image.
    image_source_details Sequence[core.GetImagesImageImageSourceDetail]
    instance_id str
    launch_mode str
    Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:

    • NATIVE - VM instances launch with iSCSI boot and VFIO devices. The default value for platform 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.
    launch_options Sequence[core.GetImagesImageLaunchOption]
    Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
    listing_type str
    The listing type of the image. The default value is "NONE".
    operating_system str
    The image's operating system. Example: Oracle Linux
    operating_system_version str
    The image's operating system version. Example: 7.2
    size_in_mbs str
    The boot volume size for an instance launched from this image (1 MB = 1,048,576 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
    state str
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    time_created str
    The date and time the image was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    agentFeatures List<Property Map>
    Oracle Cloud Agent features supported on the image.
    baseImageId String
    The OCID of the image originally used to launch the instance.
    billableSizeInGbs String
    The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: 100
    compartmentId String
    The OCID of the compartment.
    createImageAllowed Boolean
    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
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    A filter to return only resources that match the given display name exactly.
    freeformTags Map<String>
    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"}
    id String
    The OCID of the image.
    imageSourceDetails List<Property Map>
    instanceId String
    launchMode String
    Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:

    • NATIVE - VM instances launch with iSCSI boot and VFIO devices. The default value for platform 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.
    launchOptions List<Property Map>
    Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
    listingType String
    The listing type of the image. The default value is "NONE".
    operatingSystem String
    The image's operating system. Example: Oracle Linux
    operatingSystemVersion String
    The image's operating system version. Example: 7.2
    sizeInMbs String
    The boot volume size for an instance launched from this image (1 MB = 1,048,576 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
    state String
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    timeCreated String
    The date and time the image was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

    GetImagesImageAgentFeature

    IsManagementSupported bool
    This attribute is not used.
    IsMonitoringSupported bool
    This attribute is not used.
    IsManagementSupported bool
    This attribute is not used.
    IsMonitoringSupported bool
    This attribute is not used.
    isManagementSupported Boolean
    This attribute is not used.
    isMonitoringSupported Boolean
    This attribute is not used.
    isManagementSupported boolean
    This attribute is not used.
    isMonitoringSupported boolean
    This attribute is not used.
    is_management_supported bool
    This attribute is not used.
    is_monitoring_supported bool
    This attribute is not used.
    isManagementSupported Boolean
    This attribute is not used.
    isMonitoringSupported Boolean
    This attribute is not used.

    GetImagesImageImageSourceDetail

    BucketName string
    NamespaceName string
    ObjectName string
    OperatingSystem string
    The image's operating system. Example: Oracle Linux
    OperatingSystemVersion string
    The image's operating system version. Example: 7.2
    SourceImageType string
    SourceType string
    SourceUri string
    BucketName string
    NamespaceName string
    ObjectName string
    OperatingSystem string
    The image's operating system. Example: Oracle Linux
    OperatingSystemVersion string
    The image's operating system version. Example: 7.2
    SourceImageType string
    SourceType string
    SourceUri string
    bucketName String
    namespaceName String
    objectName String
    operatingSystem String
    The image's operating system. Example: Oracle Linux
    operatingSystemVersion String
    The image's operating system version. Example: 7.2
    sourceImageType String
    sourceType String
    sourceUri String
    bucketName string
    namespaceName string
    objectName string
    operatingSystem string
    The image's operating system. Example: Oracle Linux
    operatingSystemVersion string
    The image's operating system version. Example: 7.2
    sourceImageType string
    sourceType string
    sourceUri string
    bucket_name str
    namespace_name str
    object_name str
    operating_system str
    The image's operating system. Example: Oracle Linux
    operating_system_version str
    The image's operating system version. Example: 7.2
    source_image_type str
    source_type str
    source_uri str
    bucketName String
    namespaceName String
    objectName String
    operatingSystem String
    The image's operating system. Example: Oracle Linux
    operatingSystemVersion String
    The image's operating system version. Example: 7.2
    sourceImageType String
    sourceType String
    sourceUri String

    GetImagesImageLaunchOption

    BootVolumeType string
    Emulation type for the boot volume.

    • ISCSI - ISCSI attached block storage device.
    • SCSI - Emulated SCSI disk.
    • IDE - Emulated IDE disk.
    • VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
    • PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
    Firmware string
    Firmware used to boot VM. Select the option that matches your operating system.

    • BIOS - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
    • UEFI_64 - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.
    IsConsistentVolumeNamingEnabled bool
    Whether to enable consistent volume naming feature. Defaults to false.
    IsPvEncryptionInTransitEnabled bool
    Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    NetworkType string
    Emulation type for the physical network interface card (NIC).

    • E1000 - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
    • VFIO - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
    • PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.
    RemoteDataVolumeType string
    Emulation type for volume.

    • ISCSI - ISCSI attached block storage device.
    • SCSI - Emulated SCSI disk.
    • IDE - Emulated IDE disk.
    • VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
    • PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
    BootVolumeType string
    Emulation type for the boot volume.

    • ISCSI - ISCSI attached block storage device.
    • SCSI - Emulated SCSI disk.
    • IDE - Emulated IDE disk.
    • VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
    • PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
    Firmware string
    Firmware used to boot VM. Select the option that matches your operating system.

    • BIOS - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
    • UEFI_64 - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.
    IsConsistentVolumeNamingEnabled bool
    Whether to enable consistent volume naming feature. Defaults to false.
    IsPvEncryptionInTransitEnabled bool
    Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    NetworkType string
    Emulation type for the physical network interface card (NIC).

    • E1000 - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
    • VFIO - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
    • PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.
    RemoteDataVolumeType string
    Emulation type for volume.

    • ISCSI - ISCSI attached block storage device.
    • SCSI - Emulated SCSI disk.
    • IDE - Emulated IDE disk.
    • VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
    • PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
    bootVolumeType String
    Emulation type for the boot volume.

    • ISCSI - ISCSI attached block storage device.
    • SCSI - Emulated SCSI disk.
    • IDE - Emulated IDE disk.
    • VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
    • PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
    firmware String
    Firmware used to boot VM. Select the option that matches your operating system.

    • BIOS - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
    • UEFI_64 - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.
    isConsistentVolumeNamingEnabled Boolean
    Whether to enable consistent volume naming feature. Defaults to false.
    isPvEncryptionInTransitEnabled Boolean
    Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    networkType String
    Emulation type for the physical network interface card (NIC).

    • E1000 - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
    • VFIO - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
    • PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.
    remoteDataVolumeType String
    Emulation type for volume.

    • ISCSI - ISCSI attached block storage device.
    • SCSI - Emulated SCSI disk.
    • IDE - Emulated IDE disk.
    • VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
    • PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
    bootVolumeType string
    Emulation type for the boot volume.

    • ISCSI - ISCSI attached block storage device.
    • SCSI - Emulated SCSI disk.
    • IDE - Emulated IDE disk.
    • VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
    • PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
    firmware string
    Firmware used to boot VM. Select the option that matches your operating system.

    • BIOS - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
    • UEFI_64 - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.
    isConsistentVolumeNamingEnabled boolean
    Whether to enable consistent volume naming feature. Defaults to false.
    isPvEncryptionInTransitEnabled boolean
    Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    networkType string
    Emulation type for the physical network interface card (NIC).

    • E1000 - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
    • VFIO - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
    • PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.
    remoteDataVolumeType string
    Emulation type for volume.

    • ISCSI - ISCSI attached block storage device.
    • SCSI - Emulated SCSI disk.
    • IDE - Emulated IDE disk.
    • VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
    • PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
    boot_volume_type str
    Emulation type for the boot volume.

    • ISCSI - ISCSI attached block storage device.
    • SCSI - Emulated SCSI disk.
    • IDE - Emulated IDE disk.
    • VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
    • PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
    firmware str
    Firmware used to boot VM. Select the option that matches your operating system.

    • BIOS - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
    • UEFI_64 - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.
    is_consistent_volume_naming_enabled bool
    Whether to enable consistent volume naming feature. Defaults to false.
    is_pv_encryption_in_transit_enabled bool
    Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    network_type str
    Emulation type for the physical network interface card (NIC).

    • E1000 - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
    • VFIO - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
    • PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.
    remote_data_volume_type str
    Emulation type for volume.

    • ISCSI - ISCSI attached block storage device.
    • SCSI - Emulated SCSI disk.
    • IDE - Emulated IDE disk.
    • VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
    • PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
    bootVolumeType String
    Emulation type for the boot volume.

    • ISCSI - ISCSI attached block storage device.
    • SCSI - Emulated SCSI disk.
    • IDE - Emulated IDE disk.
    • VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
    • PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
    firmware String
    Firmware used to boot VM. Select the option that matches your operating system.

    • BIOS - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
    • UEFI_64 - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.
    isConsistentVolumeNamingEnabled Boolean
    Whether to enable consistent volume naming feature. Defaults to false.
    isPvEncryptionInTransitEnabled Boolean
    Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    networkType String
    Emulation type for the physical network interface card (NIC).

    • E1000 - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
    • VFIO - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
    • PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.
    remoteDataVolumeType String
    Emulation type for volume.

    • ISCSI - ISCSI attached block storage device.
    • SCSI - Emulated SCSI disk.
    • IDE - Emulated IDE disk.
    • VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
    • PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi