1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiInstanceSnapshot
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getPiInstanceSnapshot

Explore with Pulumi AI

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

    Retrieve information about a Power Systems Virtual Server instance snapshot. For more information, about Power Virtual Server instance snapshot, see getting started with IBM Power Systems Virtual Servers.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const dsInstanceSnapshot = ibm.getPiInstanceSnapshot({
        piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
        piSnapshotId: "2ce22124-4c32-6456-bfce-803e0658ab12",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    ds_instance_snapshot = ibm.get_pi_instance_snapshot(pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b",
        pi_snapshot_id="2ce22124-4c32-6456-bfce-803e0658ab12")
    
    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.LookupPiInstanceSnapshot(ctx, &ibm.LookupPiInstanceSnapshotArgs{
    			PiCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    			PiSnapshotId:      "2ce22124-4c32-6456-bfce-803e0658ab12",
    		}, 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 dsInstanceSnapshot = Ibm.GetPiInstanceSnapshot.Invoke(new()
        {
            PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
            PiSnapshotId = "2ce22124-4c32-6456-bfce-803e0658ab12",
        });
    
    });
    
    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.GetPiInstanceSnapshotArgs;
    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 dsInstanceSnapshot = IbmFunctions.getPiInstanceSnapshot(GetPiInstanceSnapshotArgs.builder()
                .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
                .piSnapshotId("2ce22124-4c32-6456-bfce-803e0658ab12")
                .build());
    
        }
    }
    
    variables:
      dsInstanceSnapshot:
        fn::invoke:
          function: ibm:getPiInstanceSnapshot
          arguments:
            piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b
            piSnapshotId: 2ce22124-4c32-6456-bfce-803e0658ab12
    

    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 getPiInstanceSnapshot

    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 getPiInstanceSnapshot(args: GetPiInstanceSnapshotArgs, opts?: InvokeOptions): Promise<GetPiInstanceSnapshotResult>
    function getPiInstanceSnapshotOutput(args: GetPiInstanceSnapshotOutputArgs, opts?: InvokeOptions): Output<GetPiInstanceSnapshotResult>
    def get_pi_instance_snapshot(id: Optional[str] = None,
                                 pi_cloud_instance_id: Optional[str] = None,
                                 pi_snapshot_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetPiInstanceSnapshotResult
    def get_pi_instance_snapshot_output(id: Optional[pulumi.Input[str]] = None,
                                 pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                                 pi_snapshot_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetPiInstanceSnapshotResult]
    func LookupPiInstanceSnapshot(ctx *Context, args *LookupPiInstanceSnapshotArgs, opts ...InvokeOption) (*LookupPiInstanceSnapshotResult, error)
    func LookupPiInstanceSnapshotOutput(ctx *Context, args *LookupPiInstanceSnapshotOutputArgs, opts ...InvokeOption) LookupPiInstanceSnapshotResultOutput

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

    public static class GetPiInstanceSnapshot 
    {
        public static Task<GetPiInstanceSnapshotResult> InvokeAsync(GetPiInstanceSnapshotArgs args, InvokeOptions? opts = null)
        public static Output<GetPiInstanceSnapshotResult> Invoke(GetPiInstanceSnapshotInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPiInstanceSnapshotResult> getPiInstanceSnapshot(GetPiInstanceSnapshotArgs args, InvokeOptions options)
    public static Output<GetPiInstanceSnapshotResult> getPiInstanceSnapshot(GetPiInstanceSnapshotArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getPiInstanceSnapshot:getPiInstanceSnapshot
      arguments:
        # arguments dictionary

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiSnapshotId string
    The unique identifier of the Power Systems Virtual Machine instance snapshot.
    Id string
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiSnapshotId string
    The unique identifier of the Power Systems Virtual Machine instance snapshot.
    Id string
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piSnapshotId String
    The unique identifier of the Power Systems Virtual Machine instance snapshot.
    id String
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piSnapshotId string
    The unique identifier of the Power Systems Virtual Machine instance snapshot.
    id string
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_snapshot_id str
    The unique identifier of the Power Systems Virtual Machine instance snapshot.
    id str
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piSnapshotId String
    The unique identifier of the Power Systems Virtual Machine instance snapshot.
    id String

    getPiInstanceSnapshot Result

    The following output properties are available:

    Action string
    (String) Action performed on the instance snapshot.
    CreationDate string
    (String) Date of snapshot creation.
    Crn string
    (String) The CRN of this resource.
    Description string
    (String) The description of the snapshot.
    Id string
    LastUpdatedDate string
    (String) Date of last update.
    Name string
    (String) The name of the Power Systems Virtual Machine instance snapshot.
    PercentComplete double
    (Integer) The snapshot completion percentage.
    PiCloudInstanceId string
    PiSnapshotId string
    Status string
    (String) The status of the Power Virtual Machine instance snapshot.
    UserTags List<string>
    (List) List of user tags attached to the resource.
    VolumeSnapshots Dictionary<string, string>
    (Map) A map of volume snapshots included in the Power Virtual Machine instance snapshot.
    Action string
    (String) Action performed on the instance snapshot.
    CreationDate string
    (String) Date of snapshot creation.
    Crn string
    (String) The CRN of this resource.
    Description string
    (String) The description of the snapshot.
    Id string
    LastUpdatedDate string
    (String) Date of last update.
    Name string
    (String) The name of the Power Systems Virtual Machine instance snapshot.
    PercentComplete float64
    (Integer) The snapshot completion percentage.
    PiCloudInstanceId string
    PiSnapshotId string
    Status string
    (String) The status of the Power Virtual Machine instance snapshot.
    UserTags []string
    (List) List of user tags attached to the resource.
    VolumeSnapshots map[string]string
    (Map) A map of volume snapshots included in the Power Virtual Machine instance snapshot.
    action String
    (String) Action performed on the instance snapshot.
    creationDate String
    (String) Date of snapshot creation.
    crn String
    (String) The CRN of this resource.
    description String
    (String) The description of the snapshot.
    id String
    lastUpdatedDate String
    (String) Date of last update.
    name String
    (String) The name of the Power Systems Virtual Machine instance snapshot.
    percentComplete Double
    (Integer) The snapshot completion percentage.
    piCloudInstanceId String
    piSnapshotId String
    status String
    (String) The status of the Power Virtual Machine instance snapshot.
    userTags List<String>
    (List) List of user tags attached to the resource.
    volumeSnapshots Map<String,String>
    (Map) A map of volume snapshots included in the Power Virtual Machine instance snapshot.
    action string
    (String) Action performed on the instance snapshot.
    creationDate string
    (String) Date of snapshot creation.
    crn string
    (String) The CRN of this resource.
    description string
    (String) The description of the snapshot.
    id string
    lastUpdatedDate string
    (String) Date of last update.
    name string
    (String) The name of the Power Systems Virtual Machine instance snapshot.
    percentComplete number
    (Integer) The snapshot completion percentage.
    piCloudInstanceId string
    piSnapshotId string
    status string
    (String) The status of the Power Virtual Machine instance snapshot.
    userTags string[]
    (List) List of user tags attached to the resource.
    volumeSnapshots {[key: string]: string}
    (Map) A map of volume snapshots included in the Power Virtual Machine instance snapshot.
    action str
    (String) Action performed on the instance snapshot.
    creation_date str
    (String) Date of snapshot creation.
    crn str
    (String) The CRN of this resource.
    description str
    (String) The description of the snapshot.
    id str
    last_updated_date str
    (String) Date of last update.
    name str
    (String) The name of the Power Systems Virtual Machine instance snapshot.
    percent_complete float
    (Integer) The snapshot completion percentage.
    pi_cloud_instance_id str
    pi_snapshot_id str
    status str
    (String) The status of the Power Virtual Machine instance snapshot.
    user_tags Sequence[str]
    (List) List of user tags attached to the resource.
    volume_snapshots Mapping[str, str]
    (Map) A map of volume snapshots included in the Power Virtual Machine instance snapshot.
    action String
    (String) Action performed on the instance snapshot.
    creationDate String
    (String) Date of snapshot creation.
    crn String
    (String) The CRN of this resource.
    description String
    (String) The description of the snapshot.
    id String
    lastUpdatedDate String
    (String) Date of last update.
    name String
    (String) The name of the Power Systems Virtual Machine instance snapshot.
    percentComplete Number
    (Integer) The snapshot completion percentage.
    piCloudInstanceId String
    piSnapshotId String
    status String
    (String) The status of the Power Virtual Machine instance snapshot.
    userTags List<String>
    (List) List of user tags attached to the resource.
    volumeSnapshots Map<String>
    (Map) A map of volume snapshots included in the Power Virtual Machine instance snapshot.

    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