1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiVolumeClone
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getPiVolumeClone

Explore with Pulumi AI

ibm logo
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

    Retrieves information about a volume clone. For more information, about managing volume clone, see getting started with IBM Power Systems Virtual Servers.

    Example Usage

    The following example retrieves information about the volume clone task that is present in Power Systems Virtual Server.

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const dsVolumeClone = ibm.getPiVolumeClone({
        piCloudInstanceId: "<value of the cloud_instance_id>",
        piVolumeCloneTaskId: "<clone task id>",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    ds_volume_clone = ibm.get_pi_volume_clone(pi_cloud_instance_id="<value of the cloud_instance_id>",
        pi_volume_clone_task_id="<clone task id>")
    
    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.LookupPiVolumeClone(ctx, &ibm.LookupPiVolumeCloneArgs{
    			PiCloudInstanceId:   "<value of the cloud_instance_id>",
    			PiVolumeCloneTaskId: "<clone task id>",
    		}, 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 dsVolumeClone = Ibm.GetPiVolumeClone.Invoke(new()
        {
            PiCloudInstanceId = "<value of the cloud_instance_id>",
            PiVolumeCloneTaskId = "<clone task id>",
        });
    
    });
    
    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.GetPiVolumeCloneArgs;
    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 dsVolumeClone = IbmFunctions.getPiVolumeClone(GetPiVolumeCloneArgs.builder()
                .piCloudInstanceId("<value of the cloud_instance_id>")
                .piVolumeCloneTaskId("<clone task id>")
                .build());
    
        }
    }
    
    variables:
      dsVolumeClone:
        fn::invoke:
          function: ibm:getPiVolumeClone
          arguments:
            piCloudInstanceId: <value of the cloud_instance_id>
            piVolumeCloneTaskId: <clone task id>
    

    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 getPiVolumeClone

    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 getPiVolumeClone(args: GetPiVolumeCloneArgs, opts?: InvokeOptions): Promise<GetPiVolumeCloneResult>
    function getPiVolumeCloneOutput(args: GetPiVolumeCloneOutputArgs, opts?: InvokeOptions): Output<GetPiVolumeCloneResult>
    def get_pi_volume_clone(id: Optional[str] = None,
                            pi_cloud_instance_id: Optional[str] = None,
                            pi_volume_clone_task_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetPiVolumeCloneResult
    def get_pi_volume_clone_output(id: Optional[pulumi.Input[str]] = None,
                            pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                            pi_volume_clone_task_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetPiVolumeCloneResult]
    func LookupPiVolumeClone(ctx *Context, args *LookupPiVolumeCloneArgs, opts ...InvokeOption) (*LookupPiVolumeCloneResult, error)
    func LookupPiVolumeCloneOutput(ctx *Context, args *LookupPiVolumeCloneOutputArgs, opts ...InvokeOption) LookupPiVolumeCloneResultOutput

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

    public static class GetPiVolumeClone 
    {
        public static Task<GetPiVolumeCloneResult> InvokeAsync(GetPiVolumeCloneArgs args, InvokeOptions? opts = null)
        public static Output<GetPiVolumeCloneResult> Invoke(GetPiVolumeCloneInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPiVolumeCloneResult> getPiVolumeClone(GetPiVolumeCloneArgs args, InvokeOptions options)
    public static Output<GetPiVolumeCloneResult> getPiVolumeClone(GetPiVolumeCloneArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getPiVolumeClone:getPiVolumeClone
      arguments:
        # arguments dictionary

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiVolumeCloneTaskId string
    The ID of the volume clone task.
    Id string
    (String) The unique identifier of the volume clone task.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiVolumeCloneTaskId string
    The ID of the volume clone task.
    Id string
    (String) The unique identifier of the volume clone task.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piVolumeCloneTaskId String
    The ID of the volume clone task.
    id String
    (String) The unique identifier of the volume clone task.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piVolumeCloneTaskId string
    The ID of the volume clone task.
    id string
    (String) The unique identifier of the volume clone task.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_volume_clone_task_id str
    The ID of the volume clone task.
    id str
    (String) The unique identifier of the volume clone task.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piVolumeCloneTaskId String
    The ID of the volume clone task.
    id String
    (String) The unique identifier of the volume clone task.

    getPiVolumeClone Result

    The following output properties are available:

    CloneVolumes List<GetPiVolumeCloneCloneVolume>
    FailureReason string
    (String) The reason for the failure of the clone volume task.
    Id string
    (String) The unique identifier of the volume clone task.
    PercentComplete double
    (Integer) The completion percentage of the volume clone task.
    PiCloudInstanceId string
    PiVolumeCloneTaskId string
    Status string
    (String) The status of the volume clone task.
    CloneVolumes []GetPiVolumeCloneCloneVolume
    FailureReason string
    (String) The reason for the failure of the clone volume task.
    Id string
    (String) The unique identifier of the volume clone task.
    PercentComplete float64
    (Integer) The completion percentage of the volume clone task.
    PiCloudInstanceId string
    PiVolumeCloneTaskId string
    Status string
    (String) The status of the volume clone task.
    cloneVolumes List<GetPiVolumeCloneCloneVolume>
    failureReason String
    (String) The reason for the failure of the clone volume task.
    id String
    (String) The unique identifier of the volume clone task.
    percentComplete Double
    (Integer) The completion percentage of the volume clone task.
    piCloudInstanceId String
    piVolumeCloneTaskId String
    status String
    (String) The status of the volume clone task.
    cloneVolumes GetPiVolumeCloneCloneVolume[]
    failureReason string
    (String) The reason for the failure of the clone volume task.
    id string
    (String) The unique identifier of the volume clone task.
    percentComplete number
    (Integer) The completion percentage of the volume clone task.
    piCloudInstanceId string
    piVolumeCloneTaskId string
    status string
    (String) The status of the volume clone task.
    clone_volumes Sequence[GetPiVolumeCloneCloneVolume]
    failure_reason str
    (String) The reason for the failure of the clone volume task.
    id str
    (String) The unique identifier of the volume clone task.
    percent_complete float
    (Integer) The completion percentage of the volume clone task.
    pi_cloud_instance_id str
    pi_volume_clone_task_id str
    status str
    (String) The status of the volume clone task.
    cloneVolumes List<Property Map>
    failureReason String
    (String) The reason for the failure of the clone volume task.
    id String
    (String) The unique identifier of the volume clone task.
    percentComplete Number
    (Integer) The completion percentage of the volume clone task.
    piCloudInstanceId String
    piVolumeCloneTaskId String
    status String
    (String) The status of the volume clone task.

    Supporting Types

    GetPiVolumeCloneCloneVolume

    CloneVolumeId string
    (String) The ID of the newly cloned volume.
    SourceVolumeId string
    (String) The ID of the source volume.
    CloneVolumeId string
    (String) The ID of the newly cloned volume.
    SourceVolumeId string
    (String) The ID of the source volume.
    cloneVolumeId String
    (String) The ID of the newly cloned volume.
    sourceVolumeId String
    (String) The ID of the source volume.
    cloneVolumeId string
    (String) The ID of the newly cloned volume.
    sourceVolumeId string
    (String) The ID of the source volume.
    clone_volume_id str
    (String) The ID of the newly cloned volume.
    source_volume_id str
    (String) The ID of the source volume.
    cloneVolumeId String
    (String) The ID of the newly cloned volume.
    sourceVolumeId String
    (String) The ID of the source volume.

    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.77.1 published on Monday, Apr 14, 2025 by ibm-cloud