Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiCatalogImages
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getPiCatalogImages

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Retrieve the details of an image that you can use in your Power Systems Virtual Server instance for copying into IBM Cloud instances. For more information, about catalog images, see provisioning a virtual server instance from a third-party image.

    Example Usage

    The following example shows how to retrieve information using ibm.getPiCatalogImages.

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const dsImages = ibm.getPiCatalogImages({
    piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
});

    import pulumi
import pulumi_ibm as ibm

ds_images = ibm.get_pi_catalog_images(pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.GetPiCatalogImages(ctx, &ibm.GetPiCatalogImagesArgs{
			PiCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var dsImages = Ibm.GetPiCatalogImages.Invoke(new()
    {
        PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetPiCatalogImagesArgs;
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 dsImages = IbmFunctions.getPiCatalogImages(GetPiCatalogImagesArgs.builder()
            .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
            .build());

    }
}

    variables:
  dsImages:
    fn::invoke:
      function: ibm:getPiCatalogImages
      arguments:
        piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b

    Notes

    • Please find supported Regions for endpoints.
    • If a Power cloud instance is provisioned at lon04, The provider level attributes should be as follows:
      • region - lon
      • zone - lon04

    Example usage:

    import * as pulumi from "@pulumi/pulumi";

    import pulumi

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
    }
}

    {}

    Using getPiCatalogImages

    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 getPiCatalogImages(args: GetPiCatalogImagesArgs, opts?: InvokeOptions): Promise<GetPiCatalogImagesResult>
function getPiCatalogImagesOutput(args: GetPiCatalogImagesOutputArgs, opts?: InvokeOptions): Output<GetPiCatalogImagesResult>
    def get_pi_catalog_images(id: Optional[str] = None,
                          pi_cloud_instance_id: Optional[str] = None,
                          sap: Optional[bool] = None,
                          vtl: Optional[bool] = None,
                          opts: Optional[InvokeOptions] = None) -> GetPiCatalogImagesResult
def get_pi_catalog_images_output(id: Optional[pulumi.Input[str]] = None,
                          pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                          sap: Optional[pulumi.Input[bool]] = None,
                          vtl: Optional[pulumi.Input[bool]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetPiCatalogImagesResult]
    func GetPiCatalogImages(ctx *Context, args *GetPiCatalogImagesArgs, opts ...InvokeOption) (*GetPiCatalogImagesResult, error)
func GetPiCatalogImagesOutput(ctx *Context, args *GetPiCatalogImagesOutputArgs, opts ...InvokeOption) GetPiCatalogImagesResultOutput

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

    public static class GetPiCatalogImages 
{
    public static Task<GetPiCatalogImagesResult> InvokeAsync(GetPiCatalogImagesArgs args, InvokeOptions? opts = null)
    public static Output<GetPiCatalogImagesResult> Invoke(GetPiCatalogImagesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPiCatalogImagesResult> getPiCatalogImages(GetPiCatalogImagesArgs args, InvokeOptions options)
public static Output<GetPiCatalogImagesResult> getPiCatalogImages(GetPiCatalogImagesArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getPiCatalogImages:getPiCatalogImages
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    Sap bool
    Set true to include SAP images. The default value is false.
    Vtl bool
    Set true to include VTL images. The default value is false.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    Sap bool
    Set true to include SAP images. The default value is false.
    Vtl bool
    Set true to include VTL images. The default value is false.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String
    sap Boolean
    Set true to include SAP images. The default value is false.
    vtl Boolean
    Set true to include VTL images. The default value is false.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    id string
    sap boolean
    Set true to include SAP images. The default value is false.
    vtl boolean
    Set true to include VTL images. The default value is false.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    id str
    sap bool
    Set true to include SAP images. The default value is false.
    vtl bool
    Set true to include VTL images. The default value is false.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String
    sap Boolean
    Set true to include SAP images. The default value is false.
    vtl Boolean
    Set true to include VTL images. The default value is false.

    getPiCatalogImages Result

    The following output properties are available:

    Id string
    Images List<GetPiCatalogImagesImage>
    (List) Lists all the images in the IBM Power Virtual Server Cloud.
    PiCloudInstanceId string
    Sap bool
    Vtl bool
    Id string
    Images []GetPiCatalogImagesImage
    (List) Lists all the images in the IBM Power Virtual Server Cloud.
    PiCloudInstanceId string
    Sap bool
    Vtl bool
    id String
    images List<GetPiCatalogImagesImage>
    (List) Lists all the images in the IBM Power Virtual Server Cloud.
    piCloudInstanceId String
    sap Boolean
    vtl Boolean
    id string
    images GetPiCatalogImagesImage[]
    (List) Lists all the images in the IBM Power Virtual Server Cloud.
    piCloudInstanceId string
    sap boolean
    vtl boolean
    id str
    images Sequence[GetPiCatalogImagesImage]
    (List) Lists all the images in the IBM Power Virtual Server Cloud.
    pi_cloud_instance_id str
    sap bool
    vtl bool
    id String
    images List<Property Map>
    (List) Lists all the images in the IBM Power Virtual Server Cloud.
    piCloudInstanceId String
    sap Boolean
    vtl Boolean

    Supporting Types

    GetPiCatalogImagesImage

    Architecture string
    (String) The CPU architecture that the image is designed for.
    ContainerFormat string
    (String) The container format.
    CreationDate string
    (String) Date of image creation.
    Crn string
    (String) The CRN of this resource.
    Description string
    (String) The description of an image.
    DiskFormat string
    (String) The disk format.
    Endianness string
    (String) The Endianness order.
    Href string
    (String) The href of an image.
    HypervisorType string
    (String) Hypervisor type.
    ImageId string
    (String) The unique identifier of an image.
    ImageType string
    (String) The identifier of this image type.
    LastUpdateDate string
    (String) The last updated date of an image.
    Name string
    (String) The name of the image.
    OperatingSystem string
    (String) Operating System.
    State string
    (String) The state of an Operating System.
    StoragePool string
    (String) Storage pool where image resides.
    StorageType string
    (String) The storage type of an image.
    Architecture string
    (String) The CPU architecture that the image is designed for.
    ContainerFormat string
    (String) The container format.
    CreationDate string
    (String) Date of image creation.
    Crn string
    (String) The CRN of this resource.
    Description string
    (String) The description of an image.
    DiskFormat string
    (String) The disk format.
    Endianness string
    (String) The Endianness order.
    Href string
    (String) The href of an image.
    HypervisorType string
    (String) Hypervisor type.
    ImageId string
    (String) The unique identifier of an image.
    ImageType string
    (String) The identifier of this image type.
    LastUpdateDate string
    (String) The last updated date of an image.
    Name string
    (String) The name of the image.
    OperatingSystem string
    (String) Operating System.
    State string
    (String) The state of an Operating System.
    StoragePool string
    (String) Storage pool where image resides.
    StorageType string
    (String) The storage type of an image.
    architecture String
    (String) The CPU architecture that the image is designed for.
    containerFormat String
    (String) The container format.
    creationDate String
    (String) Date of image creation.
    crn String
    (String) The CRN of this resource.
    description String
    (String) The description of an image.
    diskFormat String
    (String) The disk format.
    endianness String
    (String) The Endianness order.
    href String
    (String) The href of an image.
    hypervisorType String
    (String) Hypervisor type.
    imageId String
    (String) The unique identifier of an image.
    imageType String
    (String) The identifier of this image type.
    lastUpdateDate String
    (String) The last updated date of an image.
    name String
    (String) The name of the image.
    operatingSystem String
    (String) Operating System.
    state String
    (String) The state of an Operating System.
    storagePool String
    (String) Storage pool where image resides.
    storageType String
    (String) The storage type of an image.
    architecture string
    (String) The CPU architecture that the image is designed for.
    containerFormat string
    (String) The container format.
    creationDate string
    (String) Date of image creation.
    crn string
    (String) The CRN of this resource.
    description string
    (String) The description of an image.
    diskFormat string
    (String) The disk format.
    endianness string
    (String) The Endianness order.
    href string
    (String) The href of an image.
    hypervisorType string
    (String) Hypervisor type.
    imageId string
    (String) The unique identifier of an image.
    imageType string
    (String) The identifier of this image type.
    lastUpdateDate string
    (String) The last updated date of an image.
    name string
    (String) The name of the image.
    operatingSystem string
    (String) Operating System.
    state string
    (String) The state of an Operating System.
    storagePool string
    (String) Storage pool where image resides.
    storageType string
    (String) The storage type of an image.
    architecture str
    (String) The CPU architecture that the image is designed for.
    container_format str
    (String) The container format.
    creation_date str
    (String) Date of image creation.
    crn str
    (String) The CRN of this resource.
    description str
    (String) The description of an image.
    disk_format str
    (String) The disk format.
    endianness str
    (String) The Endianness order.
    href str
    (String) The href of an image.
    hypervisor_type str
    (String) Hypervisor type.
    image_id str
    (String) The unique identifier of an image.
    image_type str
    (String) The identifier of this image type.
    last_update_date str
    (String) The last updated date of an image.
    name str
    (String) The name of the image.
    operating_system str
    (String) Operating System.
    state str
    (String) The state of an Operating System.
    storage_pool str
    (String) Storage pool where image resides.
    storage_type str
    (String) The storage type of an image.
    architecture String
    (String) The CPU architecture that the image is designed for.
    containerFormat String
    (String) The container format.
    creationDate String
    (String) Date of image creation.
    crn String
    (String) The CRN of this resource.
    description String
    (String) The description of an image.
    diskFormat String
    (String) The disk format.
    endianness String
    (String) The Endianness order.
    href String
    (String) The href of an image.
    hypervisorType String
    (String) Hypervisor type.
    imageId String
    (String) The unique identifier of an image.
    imageType String
    (String) The identifier of this image type.
    lastUpdateDate String
    (String) The last updated date of an image.
    name String
    (String) The name of the image.
    operatingSystem String
    (String) Operating System.
    state String
    (String) The state of an Operating System.
    storagePool String
    (String) Storage pool where image resides.
    storageType String
    (String) The storage type of an image.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm