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

ibm.PiVolumeOnboarding

Explore with Pulumi AI

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

    Creates volume onboarding. For more information, about managing volume groups, see getting started with IBM Power Systems Virtual Servers.

    Example Usage

    The following example attaches volume to a power systems virtual server instance.

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

const testaccVolumeOnboarding = new ibm.PiVolumeOnboarding("testaccVolumeOnboarding", {
    piCloudInstanceId: "<value of the cloud_instance_id>",
    piDescription: "volume-onboarding-1",
    piOnboardingVolumes: [{
        piAuxiliaryVolumes: [{
            piAuxiliaryVolumeName: "< auxiliary volume name >",
            piDisplayName: "< display name >",
        }],
        piSourceCrn: "< source crn >",
    }],
});

    import pulumi
import pulumi_ibm as ibm

testacc_volume_onboarding = ibm.PiVolumeOnboarding("testaccVolumeOnboarding",
    pi_cloud_instance_id="<value of the cloud_instance_id>",
    pi_description="volume-onboarding-1",
    pi_onboarding_volumes=[{
        "pi_auxiliary_volumes": [{
            "pi_auxiliary_volume_name": "< auxiliary volume name >",
            "pi_display_name": "< display name >",
        }],
        "pi_source_crn": "< source crn >",
    }])

    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.NewPiVolumeOnboarding(ctx, "testaccVolumeOnboarding", &ibm.PiVolumeOnboardingArgs{
			PiCloudInstanceId: pulumi.String("<value of the cloud_instance_id>"),
			PiDescription:     pulumi.String("volume-onboarding-1"),
			PiOnboardingVolumes: ibm.PiVolumeOnboardingPiOnboardingVolumeArray{
				&ibm.PiVolumeOnboardingPiOnboardingVolumeArgs{
					PiAuxiliaryVolumes: ibm.PiVolumeOnboardingPiOnboardingVolumePiAuxiliaryVolumeArray{
						&ibm.PiVolumeOnboardingPiOnboardingVolumePiAuxiliaryVolumeArgs{
							PiAuxiliaryVolumeName: pulumi.String("< auxiliary volume name >"),
							PiDisplayName:         pulumi.String("< display name >"),
						},
					},
					PiSourceCrn: pulumi.String("< source crn >"),
				},
			},
		})
		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 testaccVolumeOnboarding = new Ibm.PiVolumeOnboarding("testaccVolumeOnboarding", new()
    {
        PiCloudInstanceId = "<value of the cloud_instance_id>",
        PiDescription = "volume-onboarding-1",
        PiOnboardingVolumes = new[]
        {
            new Ibm.Inputs.PiVolumeOnboardingPiOnboardingVolumeArgs
            {
                PiAuxiliaryVolumes = new[]
                {
                    new Ibm.Inputs.PiVolumeOnboardingPiOnboardingVolumePiAuxiliaryVolumeArgs
                    {
                        PiAuxiliaryVolumeName = "< auxiliary volume name >",
                        PiDisplayName = "< display name >",
                    },
                },
                PiSourceCrn = "< source crn >",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.PiVolumeOnboarding;
import com.pulumi.ibm.PiVolumeOnboardingArgs;
import com.pulumi.ibm.inputs.PiVolumeOnboardingPiOnboardingVolumeArgs;
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) {
        var testaccVolumeOnboarding = new PiVolumeOnboarding("testaccVolumeOnboarding", PiVolumeOnboardingArgs.builder()
            .piCloudInstanceId("<value of the cloud_instance_id>")
            .piDescription("volume-onboarding-1")
            .piOnboardingVolumes(PiVolumeOnboardingPiOnboardingVolumeArgs.builder()
                .piAuxiliaryVolumes(PiVolumeOnboardingPiOnboardingVolumePiAuxiliaryVolumeArgs.builder()
                    .piAuxiliaryVolumeName("< auxiliary volume name >")
                    .piDisplayName("< display name >")
                    .build())
                .piSourceCrn("< source crn >")
                .build())
            .build());

    }
}

    resources:
  testaccVolumeOnboarding:
    type: ibm:PiVolumeOnboarding
    properties:
      piCloudInstanceId: <value of the cloud_instance_id>
      piDescription: volume-onboarding-1
      piOnboardingVolumes:
        - piAuxiliaryVolumes:
            - piAuxiliaryVolumeName: < auxiliary volume name >
              piDisplayName: < display name >
          piSourceCrn: < source crn >

    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) {
    }
}

    {}

    Create PiVolumeOnboarding Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PiVolumeOnboarding(name: string, args: PiVolumeOnboardingArgs, opts?: CustomResourceOptions);
    @overload
def PiVolumeOnboarding(resource_name: str,
                       args: PiVolumeOnboardingArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def PiVolumeOnboarding(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       pi_cloud_instance_id: Optional[str] = None,
                       pi_onboarding_volumes: Optional[Sequence[PiVolumeOnboardingPiOnboardingVolumeArgs]] = None,
                       pi_description: Optional[str] = None,
                       pi_volume_onboarding_id: Optional[str] = None,
                       timeouts: Optional[PiVolumeOnboardingTimeoutsArgs] = None)
    func NewPiVolumeOnboarding(ctx *Context, name string, args PiVolumeOnboardingArgs, opts ...ResourceOption) (*PiVolumeOnboarding, error)
    public PiVolumeOnboarding(string name, PiVolumeOnboardingArgs args, CustomResourceOptions? opts = null)
    public PiVolumeOnboarding(String name, PiVolumeOnboardingArgs args)
public PiVolumeOnboarding(String name, PiVolumeOnboardingArgs args, CustomResourceOptions options)

    type: ibm:PiVolumeOnboarding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PiVolumeOnboardingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PiVolumeOnboardingArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PiVolumeOnboardingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PiVolumeOnboardingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PiVolumeOnboardingArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var piVolumeOnboardingResource = new Ibm.PiVolumeOnboarding("piVolumeOnboardingResource", new()
{
    PiCloudInstanceId = "string",
    PiOnboardingVolumes = new[]
    {
        new Ibm.Inputs.PiVolumeOnboardingPiOnboardingVolumeArgs
        {
            PiSourceCrn = "string",
            PiAuxiliaryVolumes = new[]
            {
                new Ibm.Inputs.PiVolumeOnboardingPiOnboardingVolumePiAuxiliaryVolumeArgs
                {
                    PiAuxiliaryVolumeName = "string",
                    PiDisplayName = "string",
                },
            },
        },
    },
    PiDescription = "string",
    PiVolumeOnboardingId = "string",
    Timeouts = new Ibm.Inputs.PiVolumeOnboardingTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
});

    example, err := ibm.NewPiVolumeOnboarding(ctx, "piVolumeOnboardingResource", &ibm.PiVolumeOnboardingArgs{
	PiCloudInstanceId: pulumi.String("string"),
	PiOnboardingVolumes: ibm.PiVolumeOnboardingPiOnboardingVolumeArray{
		&ibm.PiVolumeOnboardingPiOnboardingVolumeArgs{
			PiSourceCrn: pulumi.String("string"),
			PiAuxiliaryVolumes: ibm.PiVolumeOnboardingPiOnboardingVolumePiAuxiliaryVolumeArray{
				&ibm.PiVolumeOnboardingPiOnboardingVolumePiAuxiliaryVolumeArgs{
					PiAuxiliaryVolumeName: pulumi.String("string"),
					PiDisplayName:         pulumi.String("string"),
				},
			},
		},
	},
	PiDescription:        pulumi.String("string"),
	PiVolumeOnboardingId: pulumi.String("string"),
	Timeouts: &ibm.PiVolumeOnboardingTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
})

    var piVolumeOnboardingResource = new PiVolumeOnboarding("piVolumeOnboardingResource", PiVolumeOnboardingArgs.builder()
    .piCloudInstanceId("string")
    .piOnboardingVolumes(PiVolumeOnboardingPiOnboardingVolumeArgs.builder()
        .piSourceCrn("string")
        .piAuxiliaryVolumes(PiVolumeOnboardingPiOnboardingVolumePiAuxiliaryVolumeArgs.builder()
            .piAuxiliaryVolumeName("string")
            .piDisplayName("string")
            .build())
        .build())
    .piDescription("string")
    .piVolumeOnboardingId("string")
    .timeouts(PiVolumeOnboardingTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .build());

    pi_volume_onboarding_resource = ibm.PiVolumeOnboarding("piVolumeOnboardingResource",
    pi_cloud_instance_id="string",
    pi_onboarding_volumes=[{
        "pi_source_crn": "string",
        "pi_auxiliary_volumes": [{
            "pi_auxiliary_volume_name": "string",
            "pi_display_name": "string",
        }],
    }],
    pi_description="string",
    pi_volume_onboarding_id="string",
    timeouts={
        "create": "string",
        "delete": "string",
    })

    const piVolumeOnboardingResource = new ibm.PiVolumeOnboarding("piVolumeOnboardingResource", {
    piCloudInstanceId: "string",
    piOnboardingVolumes: [{
        piSourceCrn: "string",
        piAuxiliaryVolumes: [{
            piAuxiliaryVolumeName: "string",
            piDisplayName: "string",
        }],
    }],
    piDescription: "string",
    piVolumeOnboardingId: "string",
    timeouts: {
        create: "string",
        "delete": "string",
    },
});

    type: ibm:PiVolumeOnboarding
properties:
    piCloudInstanceId: string
    piDescription: string
    piOnboardingVolumes:
        - piAuxiliaryVolumes:
            - piAuxiliaryVolumeName: string
              piDisplayName: string
          piSourceCrn: string
    piVolumeOnboardingId: string
    timeouts:
        create: string
        delete: string

    PiVolumeOnboarding Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PiVolumeOnboarding resource accepts the following input properties:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiOnboardingVolumes List<PiVolumeOnboardingPiOnboardingVolume>

    List of onboarding volumes.

    • Constraints: The minimum length is 1 items.

    Nested scheme for pi_onboarding_volumes:

    PiDescription string
    The description of the volume onboarding operation.
    PiVolumeOnboardingId string
    (String) The unique identifier of the volume attach. The ID is composed of <pi_cloud_instance_id>/<onboarding_id>.
    Timeouts PiVolumeOnboardingTimeouts
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiOnboardingVolumes []PiVolumeOnboardingPiOnboardingVolumeArgs

    List of onboarding volumes.

    • Constraints: The minimum length is 1 items.

    Nested scheme for pi_onboarding_volumes:

    PiDescription string
    The description of the volume onboarding operation.
    PiVolumeOnboardingId string
    (String) The unique identifier of the volume attach. The ID is composed of <pi_cloud_instance_id>/<onboarding_id>.
    Timeouts PiVolumeOnboardingTimeoutsArgs
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piOnboardingVolumes List<PiVolumeOnboardingPiOnboardingVolume>

    List of onboarding volumes.

    • Constraints: The minimum length is 1 items.

    Nested scheme for pi_onboarding_volumes:

    piDescription String
    The description of the volume onboarding operation.
    piVolumeOnboardingId String
    (String) The unique identifier of the volume attach. The ID is composed of <pi_cloud_instance_id>/<onboarding_id>.
    timeouts PiVolumeOnboardingTimeouts
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piOnboardingVolumes PiVolumeOnboardingPiOnboardingVolume[]

    List of onboarding volumes.

    • Constraints: The minimum length is 1 items.

    Nested scheme for pi_onboarding_volumes:

    piDescription string
    The description of the volume onboarding operation.
    piVolumeOnboardingId string
    (String) The unique identifier of the volume attach. The ID is composed of <pi_cloud_instance_id>/<onboarding_id>.
    timeouts PiVolumeOnboardingTimeouts
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_onboarding_volumes Sequence[PiVolumeOnboardingPiOnboardingVolumeArgs]

    List of onboarding volumes.

    • Constraints: The minimum length is 1 items.

    Nested scheme for pi_onboarding_volumes:

    pi_description str
    The description of the volume onboarding operation.
    pi_volume_onboarding_id str
    (String) The unique identifier of the volume attach. The ID is composed of <pi_cloud_instance_id>/<onboarding_id>.
    timeouts PiVolumeOnboardingTimeoutsArgs
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piOnboardingVolumes List<Property Map>

    List of onboarding volumes.

    • Constraints: The minimum length is 1 items.

    Nested scheme for pi_onboarding_volumes:

    piDescription String
    The description of the volume onboarding operation.
    piVolumeOnboardingId String
    (String) The unique identifier of the volume attach. The ID is composed of <pi_cloud_instance_id>/<onboarding_id>.
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PiVolumeOnboarding resource produces the following output properties:

    CreateTime string
    (String) The create time of volume onboarding operation.
    Id string
    The provider-assigned unique ID for this managed resource.
    InputVolumes List<string>
    (List of strings) List of volumes requested to be onboarded.
    OnboardingId string
    (String) The volume onboarding ID.
    Progress double
    (Float) The progress of volume onboarding operation.
    ResultsOnboardedVolumes List<string>
    (List of strings) List of volumes which are onboarded successfully.
    ResultsVolumeOnboardingFailures List<PiVolumeOnboardingResultsVolumeOnboardingFailure>
    (List of objects) - The volume onboarding failure details.
    Status string
    (String) The status of volume onboarding operation.
    CreateTime string
    (String) The create time of volume onboarding operation.
    Id string
    The provider-assigned unique ID for this managed resource.
    InputVolumes []string
    (List of strings) List of volumes requested to be onboarded.
    OnboardingId string
    (String) The volume onboarding ID.
    Progress float64
    (Float) The progress of volume onboarding operation.
    ResultsOnboardedVolumes []string
    (List of strings) List of volumes which are onboarded successfully.
    ResultsVolumeOnboardingFailures []PiVolumeOnboardingResultsVolumeOnboardingFailure
    (List of objects) - The volume onboarding failure details.
    Status string
    (String) The status of volume onboarding operation.
    createTime String
    (String) The create time of volume onboarding operation.
    id String
    The provider-assigned unique ID for this managed resource.
    inputVolumes List<String>
    (List of strings) List of volumes requested to be onboarded.
    onboardingId String
    (String) The volume onboarding ID.
    progress Double
    (Float) The progress of volume onboarding operation.
    resultsOnboardedVolumes List<String>
    (List of strings) List of volumes which are onboarded successfully.
    resultsVolumeOnboardingFailures List<PiVolumeOnboardingResultsVolumeOnboardingFailure>
    (List of objects) - The volume onboarding failure details.
    status String
    (String) The status of volume onboarding operation.
    createTime string
    (String) The create time of volume onboarding operation.
    id string
    The provider-assigned unique ID for this managed resource.
    inputVolumes string[]
    (List of strings) List of volumes requested to be onboarded.
    onboardingId string
    (String) The volume onboarding ID.
    progress number
    (Float) The progress of volume onboarding operation.
    resultsOnboardedVolumes string[]
    (List of strings) List of volumes which are onboarded successfully.
    resultsVolumeOnboardingFailures PiVolumeOnboardingResultsVolumeOnboardingFailure[]
    (List of objects) - 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.
    id str
    The provider-assigned unique ID for this managed resource.
    input_volumes Sequence[str]
    (List of strings) List of volumes requested to be onboarded.
    onboarding_id str
    (String) The volume onboarding ID.
    progress float
    (Float) The progress of volume onboarding operation.
    results_onboarded_volumes Sequence[str]
    (List of strings) List of volumes which are onboarded successfully.
    results_volume_onboarding_failures Sequence[PiVolumeOnboardingResultsVolumeOnboardingFailure]
    (List of objects) - The volume onboarding failure details.
    status str
    (String) The status of volume onboarding operation.
    createTime String
    (String) The create time of volume onboarding operation.
    id String
    The provider-assigned unique ID for this managed resource.
    inputVolumes List<String>
    (List of strings) List of volumes requested to be onboarded.
    onboardingId String
    (String) The volume onboarding ID.
    progress Number
    (Float) The progress of volume onboarding operation.
    resultsOnboardedVolumes List<String>
    (List of strings) List of volumes which are onboarded successfully.
    resultsVolumeOnboardingFailures List<Property Map>
    (List of objects) - The volume onboarding failure details.
    status String
    (String) The status of volume onboarding operation.

    Look up Existing PiVolumeOnboarding Resource

    Get an existing PiVolumeOnboarding resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PiVolumeOnboardingState, opts?: CustomResourceOptions): PiVolumeOnboarding
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        input_volumes: Optional[Sequence[str]] = None,
        onboarding_id: Optional[str] = None,
        pi_cloud_instance_id: Optional[str] = None,
        pi_description: Optional[str] = None,
        pi_onboarding_volumes: Optional[Sequence[PiVolumeOnboardingPiOnboardingVolumeArgs]] = None,
        pi_volume_onboarding_id: Optional[str] = None,
        progress: Optional[float] = None,
        results_onboarded_volumes: Optional[Sequence[str]] = None,
        results_volume_onboarding_failures: Optional[Sequence[PiVolumeOnboardingResultsVolumeOnboardingFailureArgs]] = None,
        status: Optional[str] = None,
        timeouts: Optional[PiVolumeOnboardingTimeoutsArgs] = None) -> PiVolumeOnboarding
    func GetPiVolumeOnboarding(ctx *Context, name string, id IDInput, state *PiVolumeOnboardingState, opts ...ResourceOption) (*PiVolumeOnboarding, error)
    public static PiVolumeOnboarding Get(string name, Input<string> id, PiVolumeOnboardingState? state, CustomResourceOptions? opts = null)
    public static PiVolumeOnboarding get(String name, Output<String> id, PiVolumeOnboardingState state, CustomResourceOptions options)
    resources:  _:    type: ibm:PiVolumeOnboarding    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreateTime string
    (String) The create time of volume onboarding operation.
    InputVolumes List<string>
    (List of strings) List of volumes requested to be onboarded.
    OnboardingId string
    (String) The volume onboarding ID.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiDescription string
    The description of the volume onboarding operation.
    PiOnboardingVolumes List<PiVolumeOnboardingPiOnboardingVolume>

    List of onboarding volumes.

    • Constraints: The minimum length is 1 items.

    Nested scheme for pi_onboarding_volumes:

    PiVolumeOnboardingId string
    (String) The unique identifier of the volume attach. The ID is composed of <pi_cloud_instance_id>/<onboarding_id>.
    Progress double
    (Float) The progress of volume onboarding operation.
    ResultsOnboardedVolumes List<string>
    (List of strings) List of volumes which are onboarded successfully.
    ResultsVolumeOnboardingFailures List<PiVolumeOnboardingResultsVolumeOnboardingFailure>
    (List of objects) - The volume onboarding failure details.
    Status string
    (String) The status of volume onboarding operation.
    Timeouts PiVolumeOnboardingTimeouts
    CreateTime string
    (String) The create time of volume onboarding operation.
    InputVolumes []string
    (List of strings) List of volumes requested to be onboarded.
    OnboardingId string
    (String) The volume onboarding ID.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiDescription string
    The description of the volume onboarding operation.
    PiOnboardingVolumes []PiVolumeOnboardingPiOnboardingVolumeArgs

    List of onboarding volumes.

    • Constraints: The minimum length is 1 items.

    Nested scheme for pi_onboarding_volumes:

    PiVolumeOnboardingId string
    (String) The unique identifier of the volume attach. The ID is composed of <pi_cloud_instance_id>/<onboarding_id>.
    Progress float64
    (Float) The progress of volume onboarding operation.
    ResultsOnboardedVolumes []string
    (List of strings) List of volumes which are onboarded successfully.
    ResultsVolumeOnboardingFailures []PiVolumeOnboardingResultsVolumeOnboardingFailureArgs
    (List of objects) - The volume onboarding failure details.
    Status string
    (String) The status of volume onboarding operation.
    Timeouts PiVolumeOnboardingTimeoutsArgs
    createTime String
    (String) The create time of volume onboarding operation.
    inputVolumes List<String>
    (List of strings) List of volumes requested to be onboarded.
    onboardingId String
    (String) The volume onboarding ID.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piDescription String
    The description of the volume onboarding operation.
    piOnboardingVolumes List<PiVolumeOnboardingPiOnboardingVolume>

    List of onboarding volumes.

    • Constraints: The minimum length is 1 items.

    Nested scheme for pi_onboarding_volumes:

    piVolumeOnboardingId String
    (String) The unique identifier of the volume attach. The ID is composed of <pi_cloud_instance_id>/<onboarding_id>.
    progress Double
    (Float) The progress of volume onboarding operation.
    resultsOnboardedVolumes List<String>
    (List of strings) List of volumes which are onboarded successfully.
    resultsVolumeOnboardingFailures List<PiVolumeOnboardingResultsVolumeOnboardingFailure>
    (List of objects) - The volume onboarding failure details.
    status String
    (String) The status of volume onboarding operation.
    timeouts PiVolumeOnboardingTimeouts
    createTime string
    (String) The create time of volume onboarding operation.
    inputVolumes string[]
    (List of strings) List of volumes requested to be onboarded.
    onboardingId string
    (String) The volume onboarding ID.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piDescription string
    The description of the volume onboarding operation.
    piOnboardingVolumes PiVolumeOnboardingPiOnboardingVolume[]

    List of onboarding volumes.

    • Constraints: The minimum length is 1 items.

    Nested scheme for pi_onboarding_volumes:

    piVolumeOnboardingId string
    (String) The unique identifier of the volume attach. The ID is composed of <pi_cloud_instance_id>/<onboarding_id>.
    progress number
    (Float) The progress of volume onboarding operation.
    resultsOnboardedVolumes string[]
    (List of strings) List of volumes which are onboarded successfully.
    resultsVolumeOnboardingFailures PiVolumeOnboardingResultsVolumeOnboardingFailure[]
    (List of objects) - The volume onboarding failure details.
    status string
    (String) The status of volume onboarding operation.
    timeouts PiVolumeOnboardingTimeouts
    create_time str
    (String) The create time of volume onboarding operation.
    input_volumes Sequence[str]
    (List of strings) List of volumes requested to be onboarded.
    onboarding_id str
    (String) The volume onboarding ID.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_description str
    The description of the volume onboarding operation.
    pi_onboarding_volumes Sequence[PiVolumeOnboardingPiOnboardingVolumeArgs]

    List of onboarding volumes.

    • Constraints: The minimum length is 1 items.

    Nested scheme for pi_onboarding_volumes:

    pi_volume_onboarding_id str
    (String) The unique identifier of the volume attach. The ID is composed of <pi_cloud_instance_id>/<onboarding_id>.
    progress float
    (Float) The progress of volume onboarding operation.
    results_onboarded_volumes Sequence[str]
    (List of strings) List of volumes which are onboarded successfully.
    results_volume_onboarding_failures Sequence[PiVolumeOnboardingResultsVolumeOnboardingFailureArgs]
    (List of objects) - The volume onboarding failure details.
    status str
    (String) The status of volume onboarding operation.
    timeouts PiVolumeOnboardingTimeoutsArgs
    createTime String
    (String) The create time of volume onboarding operation.
    inputVolumes List<String>
    (List of strings) List of volumes requested to be onboarded.
    onboardingId String
    (String) The volume onboarding ID.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piDescription String
    The description of the volume onboarding operation.
    piOnboardingVolumes List<Property Map>

    List of onboarding volumes.

    • Constraints: The minimum length is 1 items.

    Nested scheme for pi_onboarding_volumes:

    piVolumeOnboardingId String
    (String) The unique identifier of the volume attach. The ID is composed of <pi_cloud_instance_id>/<onboarding_id>.
    progress Number
    (Float) The progress of volume onboarding operation.
    resultsOnboardedVolumes List<String>
    (List of strings) List of volumes which are onboarded successfully.
    resultsVolumeOnboardingFailures List<Property Map>
    (List of objects) - The volume onboarding failure details.
    status String
    (String) The status of volume onboarding operation.
    timeouts Property Map

    Supporting Types

    PiVolumeOnboardingPiOnboardingVolume, PiVolumeOnboardingPiOnboardingVolumeArgs

    PiSourceCrn string

    The crn of source service broker instance from where auxiliary volumes need to be onboarded.

    • Constraints: The minimum length is 1 items.

    Nested scheme for pi_auxiliary_volumes:

    PiAuxiliaryVolumes List<PiVolumeOnboardingPiOnboardingVolumePiAuxiliaryVolume>
    List auxiliary volumes.
    PiSourceCrn string

    The crn of source service broker instance from where auxiliary volumes need to be onboarded.

    • Constraints: The minimum length is 1 items.

    Nested scheme for pi_auxiliary_volumes:

    PiAuxiliaryVolumes []PiVolumeOnboardingPiOnboardingVolumePiAuxiliaryVolume
    List auxiliary volumes.
    piSourceCrn String

    The crn of source service broker instance from where auxiliary volumes need to be onboarded.

    • Constraints: The minimum length is 1 items.

    Nested scheme for pi_auxiliary_volumes:

    piAuxiliaryVolumes List<PiVolumeOnboardingPiOnboardingVolumePiAuxiliaryVolume>
    List auxiliary volumes.
    piSourceCrn string

    The crn of source service broker instance from where auxiliary volumes need to be onboarded.

    • Constraints: The minimum length is 1 items.

    Nested scheme for pi_auxiliary_volumes:

    piAuxiliaryVolumes PiVolumeOnboardingPiOnboardingVolumePiAuxiliaryVolume[]
    List auxiliary volumes.
    pi_source_crn str

    The crn of source service broker instance from where auxiliary volumes need to be onboarded.

    • Constraints: The minimum length is 1 items.

    Nested scheme for pi_auxiliary_volumes:

    pi_auxiliary_volumes Sequence[PiVolumeOnboardingPiOnboardingVolumePiAuxiliaryVolume]
    List auxiliary volumes.
    piSourceCrn String

    The crn of source service broker instance from where auxiliary volumes need to be onboarded.

    • Constraints: The minimum length is 1 items.

    Nested scheme for pi_auxiliary_volumes:

    piAuxiliaryVolumes List<Property Map>
    List auxiliary volumes.

    PiVolumeOnboardingPiOnboardingVolumePiAuxiliaryVolume, PiVolumeOnboardingPiOnboardingVolumePiAuxiliaryVolumeArgs

    PiAuxiliaryVolumeName string
    The auxiliary volume name.
    PiDisplayName string
    The display name of auxiliary volume which is to be onboarded.
    PiAuxiliaryVolumeName string
    The auxiliary volume name.
    PiDisplayName string
    The display name of auxiliary volume which is to be onboarded.
    piAuxiliaryVolumeName String
    The auxiliary volume name.
    piDisplayName String
    The display name of auxiliary volume which is to be onboarded.
    piAuxiliaryVolumeName string
    The auxiliary volume name.
    piDisplayName string
    The display name of auxiliary volume which is to be onboarded.
    pi_auxiliary_volume_name str
    The auxiliary volume name.
    pi_display_name str
    The display name of auxiliary volume which is to be onboarded.
    piAuxiliaryVolumeName String
    The auxiliary volume name.
    piDisplayName String
    The display name of auxiliary volume which is to be onboarded.

    PiVolumeOnboardingResultsVolumeOnboardingFailure, PiVolumeOnboardingResultsVolumeOnboardingFailureArgs

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

    PiVolumeOnboardingTimeouts, PiVolumeOnboardingTimeoutsArgs

    Create string
    Delete string
    Create string
    Delete string
    create String
    delete String
    create string
    delete string
    create str
    delete str
    create String
    delete String

    Import

    Example

    bash

    $ pulumi import ibm:index/piVolumeOnboarding:PiVolumeOnboarding example d7bec597-4726-451f-8a63-e62e6f19c32c/49fba6c9-23f8-40bc-9899-aca322ee7d5b

    To learn more about importing existing cloud resources, see Importing resources.

    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