Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiVolumeOnboarding
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getPiVolumeOnboarding

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Retrieves information about volume onboarding. For more information, about managing a volume group, see moving data to the cloud.

Example Usage

The following example retrieves information about about volume onboarding in Power Systems Virtual Server.

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

const dsVolumeOnboarding = ibm.getPiVolumeOnboarding({
    piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    piVolumeOnboardingId: "1212a6c9-23f8-40bc-9899-aca322ee7343",
});
Copy
import pulumi
import pulumi_ibm as ibm

ds_volume_onboarding = ibm.get_pi_volume_onboarding(pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    pi_volume_onboarding_id="1212a6c9-23f8-40bc-9899-aca322ee7343")
Copy
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.LookupPiVolumeOnboarding(ctx, &ibm.LookupPiVolumeOnboardingArgs{
			PiCloudInstanceId:    "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
			PiVolumeOnboardingId: "1212a6c9-23f8-40bc-9899-aca322ee7343",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var dsVolumeOnboarding = Ibm.GetPiVolumeOnboarding.Invoke(new()
    {
        PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
        PiVolumeOnboardingId = "1212a6c9-23f8-40bc-9899-aca322ee7343",
    });

});
Copy
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.GetPiVolumeOnboardingArgs;
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 dsVolumeOnboarding = IbmFunctions.getPiVolumeOnboarding(GetPiVolumeOnboardingArgs.builder()
            .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
            .piVolumeOnboardingId("1212a6c9-23f8-40bc-9899-aca322ee7343")
            .build());

    }
}
Copy
variables:
  dsVolumeOnboarding:
    fn::invoke:
      function: ibm:getPiVolumeOnboarding
      arguments:
        piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b
        piVolumeOnboardingId: 1212a6c9-23f8-40bc-9899-aca322ee7343
Copy

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";
Copy
import pulumi
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});
Copy
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) {
    }
}
Copy
{}
Copy

Using getPiVolumeOnboarding

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 getPiVolumeOnboarding(args: GetPiVolumeOnboardingArgs, opts?: InvokeOptions): Promise<GetPiVolumeOnboardingResult>
function getPiVolumeOnboardingOutput(args: GetPiVolumeOnboardingOutputArgs, opts?: InvokeOptions): Output<GetPiVolumeOnboardingResult>
Copy
def get_pi_volume_onboarding(id: Optional[str] = None,
                             pi_cloud_instance_id: Optional[str] = None,
                             pi_volume_onboarding_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetPiVolumeOnboardingResult
def get_pi_volume_onboarding_output(id: Optional[pulumi.Input[str]] = None,
                             pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                             pi_volume_onboarding_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetPiVolumeOnboardingResult]
Copy
func LookupPiVolumeOnboarding(ctx *Context, args *LookupPiVolumeOnboardingArgs, opts ...InvokeOption) (*LookupPiVolumeOnboardingResult, error)
func LookupPiVolumeOnboardingOutput(ctx *Context, args *LookupPiVolumeOnboardingOutputArgs, opts ...InvokeOption) LookupPiVolumeOnboardingResultOutput
Copy

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

public static class GetPiVolumeOnboarding 
{
    public static Task<GetPiVolumeOnboardingResult> InvokeAsync(GetPiVolumeOnboardingArgs args, InvokeOptions? opts = null)
    public static Output<GetPiVolumeOnboardingResult> Invoke(GetPiVolumeOnboardingInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPiVolumeOnboardingResult> getPiVolumeOnboarding(GetPiVolumeOnboardingArgs args, InvokeOptions options)
public static Output<GetPiVolumeOnboardingResult> getPiVolumeOnboarding(GetPiVolumeOnboardingArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getPiVolumeOnboarding:getPiVolumeOnboarding
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PiCloudInstanceId This property is required. string
The GUID of the service instance associated with an account.
PiVolumeOnboardingId This property is required. string
The ID of volume onboarding for which you want to retrieve detailed information.
Id string
(String) The volume onboarding operation id.
PiCloudInstanceId This property is required. string
The GUID of the service instance associated with an account.
PiVolumeOnboardingId This property is required. string
The ID of volume onboarding for which you want to retrieve detailed information.
Id string
(String) The volume onboarding operation id.
piCloudInstanceId This property is required. String
The GUID of the service instance associated with an account.
piVolumeOnboardingId This property is required. String
The ID of volume onboarding for which you want to retrieve detailed information.
id String
(String) The volume onboarding operation id.
piCloudInstanceId This property is required. string
The GUID of the service instance associated with an account.
piVolumeOnboardingId This property is required. string
The ID of volume onboarding for which you want to retrieve detailed information.
id string
(String) The volume onboarding operation id.
pi_cloud_instance_id This property is required. str
The GUID of the service instance associated with an account.
pi_volume_onboarding_id This property is required. str
The ID of volume onboarding for which you want to retrieve detailed information.
id str
(String) The volume onboarding operation id.
piCloudInstanceId This property is required. String
The GUID of the service instance associated with an account.
piVolumeOnboardingId This property is required. String
The ID of volume onboarding for which you want to retrieve detailed information.
id String
(String) The volume onboarding operation id.

getPiVolumeOnboarding Result

The following output properties are available:

CreateTime string
(String) The create-time of volume onboarding operation.
Description string
(String) The description of the volume onboarding operation.
Id string
(String) The volume onboarding operation id.
InputVolumes List<string>
(List) List of volumes requested to be onboarded.
PiCloudInstanceId string
PiVolumeOnboardingId string
Progress double
(String) The progress of volume onboarding operation.
ResultsOnboardedVolumes List<string>
(List) List of volumes which are onboarded successfully.
ResultsVolumeOnboardingFailures List<GetPiVolumeOnboardingResultsVolumeOnboardingFailure>
(List) The volume onboarding failure details.
Status string
(String) The status of volume onboarding operation.
CreateTime string
(String) The create-time of volume onboarding operation.
Description string
(String) The description of the volume onboarding operation.
Id string
(String) The volume onboarding operation id.
InputVolumes []string
(List) List of volumes requested to be onboarded.
PiCloudInstanceId string
PiVolumeOnboardingId string
Progress float64
(String) The progress of volume onboarding operation.
ResultsOnboardedVolumes []string
(List) List of volumes which are onboarded successfully.
ResultsVolumeOnboardingFailures []GetPiVolumeOnboardingResultsVolumeOnboardingFailure
(List) The volume onboarding failure details.
Status string
(String) The status of volume onboarding operation.
createTime String
(String) The create-time of volume onboarding operation.
description String
(String) The description of the volume onboarding operation.
id String
(String) The volume onboarding operation id.
inputVolumes List<String>
(List) List of volumes requested to be onboarded.
piCloudInstanceId String
piVolumeOnboardingId String
progress Double
(String) The progress of volume onboarding operation.
resultsOnboardedVolumes List<String>
(List) List of volumes which are onboarded successfully.
resultsVolumeOnboardingFailures List<GetPiVolumeOnboardingResultsVolumeOnboardingFailure>
(List) The volume onboarding failure details.
status String
(String) The status of volume onboarding operation.
createTime string
(String) The create-time of volume onboarding operation.
description string
(String) The description of the volume onboarding operation.
id string
(String) The volume onboarding operation id.
inputVolumes string[]
(List) List of volumes requested to be onboarded.
piCloudInstanceId string
piVolumeOnboardingId string
progress number
(String) The progress of volume onboarding operation.
resultsOnboardedVolumes string[]
(List) List of volumes which are onboarded successfully.
resultsVolumeOnboardingFailures GetPiVolumeOnboardingResultsVolumeOnboardingFailure[]
(List) The volume onboarding failure details.
status string
(String) The status of volume onboarding operation.
create_time str
(String) The create-time of volume onboarding operation.
description str
(String) The description of the volume onboarding operation.
id str
(String) The volume onboarding operation id.
input_volumes Sequence[str]
(List) List of volumes requested to be onboarded.
pi_cloud_instance_id str
pi_volume_onboarding_id str
progress float
(String) The progress of volume onboarding operation.
results_onboarded_volumes Sequence[str]
(List) List of volumes which are onboarded successfully.
results_volume_onboarding_failures Sequence[GetPiVolumeOnboardingResultsVolumeOnboardingFailure]
(List) The volume onboarding failure details.
status str
(String) The status of volume onboarding operation.
createTime String
(String) The create-time of volume onboarding operation.
description String
(String) The description of the volume onboarding operation.
id String
(String) The volume onboarding operation id.
inputVolumes List<String>
(List) List of volumes requested to be onboarded.
piCloudInstanceId String
piVolumeOnboardingId String
progress Number
(String) The progress of volume onboarding operation.
resultsOnboardedVolumes List<String>
(List) List of volumes which are onboarded successfully.
resultsVolumeOnboardingFailures List<Property Map>
(List) The volume onboarding failure details.
status String
(String) The status of volume onboarding operation.

Supporting Types

GetPiVolumeOnboardingResultsVolumeOnboardingFailure

FailureMessage This property is required. string
(String) The failure reason for the volumes which have failed to be onboarded.
Volumes This property is required. List<string>
(List) List of volumes which have failed to be onboarded.
FailureMessage This property is required. string
(String) The failure reason for the volumes which have failed to be onboarded.
Volumes This property is required. []string
(List) List of volumes which have failed to be onboarded.
failureMessage This property is required. String
(String) The failure reason for the volumes which have failed to be onboarded.
volumes This property is required. List<String>
(List) List of volumes which have failed to be onboarded.
failureMessage This property is required. string
(String) The failure reason for the volumes which have failed to be onboarded.
volumes This property is required. string[]
(List) List of volumes which have failed to be onboarded.
failure_message This property is required. str
(String) The failure reason for the volumes which have failed to be onboarded.
volumes This property is required. Sequence[str]
(List) List of volumes which have failed to be onboarded.
failureMessage This property is required. String
(String) The failure reason for the volumes which have failed to be onboarded.
volumes This property is required. List<String>
(List) List of volumes which have failed to be onboarded.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm