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

ibm.getPiVolumeRemoteCopyRelationship

Explore with Pulumi AI

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

    Retrieves information about remote copy relationship of a volume. For more information, about managing a volume group, see moving data to the cloud.

    Example Usage

    The following example retrieves information about about remote copy relationship of a volume in Power Systems Virtual Server.

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

const dsVolumeRemoteCopyRelationships = ibm.getPiVolumeRemoteCopyRelationship({
    piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    piVolumeId: "810b5fde-e054-4577-ab5e-3f866a1f6f60",
});

    import pulumi
import pulumi_ibm as ibm

ds_volume_remote_copy_relationships = ibm.get_pi_volume_remote_copy_relationship(pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    pi_volume_id="810b5fde-e054-4577-ab5e-3f866a1f6f60")

    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.GetPiVolumeRemoteCopyRelationship(ctx, &ibm.GetPiVolumeRemoteCopyRelationshipArgs{
			PiCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
			PiVolumeId:        "810b5fde-e054-4577-ab5e-3f866a1f6f60",
		}, 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 dsVolumeRemoteCopyRelationships = Ibm.GetPiVolumeRemoteCopyRelationship.Invoke(new()
    {
        PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
        PiVolumeId = "810b5fde-e054-4577-ab5e-3f866a1f6f60",
    });

});

    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.GetPiVolumeRemoteCopyRelationshipArgs;
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 dsVolumeRemoteCopyRelationships = IbmFunctions.getPiVolumeRemoteCopyRelationship(GetPiVolumeRemoteCopyRelationshipArgs.builder()
            .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
            .piVolumeId("810b5fde-e054-4577-ab5e-3f866a1f6f60")
            .build());

    }
}

    variables:
  dsVolumeRemoteCopyRelationships:
    fn::invoke:
      function: ibm:getPiVolumeRemoteCopyRelationship
      arguments:
        piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b
        piVolumeId: 810b5fde-e054-4577-ab5e-3f866a1f6f60

    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 getPiVolumeRemoteCopyRelationship

    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 getPiVolumeRemoteCopyRelationship(args: GetPiVolumeRemoteCopyRelationshipArgs, opts?: InvokeOptions): Promise<GetPiVolumeRemoteCopyRelationshipResult>
function getPiVolumeRemoteCopyRelationshipOutput(args: GetPiVolumeRemoteCopyRelationshipOutputArgs, opts?: InvokeOptions): Output<GetPiVolumeRemoteCopyRelationshipResult>
    def get_pi_volume_remote_copy_relationship(id: Optional[str] = None,
                                           pi_cloud_instance_id: Optional[str] = None,
                                           pi_volume_id: Optional[str] = None,
                                           opts: Optional[InvokeOptions] = None) -> GetPiVolumeRemoteCopyRelationshipResult
def get_pi_volume_remote_copy_relationship_output(id: Optional[pulumi.Input[str]] = None,
                                           pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                                           pi_volume_id: Optional[pulumi.Input[str]] = None,
                                           opts: Optional[InvokeOptions] = None) -> Output[GetPiVolumeRemoteCopyRelationshipResult]
    func GetPiVolumeRemoteCopyRelationship(ctx *Context, args *GetPiVolumeRemoteCopyRelationshipArgs, opts ...InvokeOption) (*GetPiVolumeRemoteCopyRelationshipResult, error)
func GetPiVolumeRemoteCopyRelationshipOutput(ctx *Context, args *GetPiVolumeRemoteCopyRelationshipOutputArgs, opts ...InvokeOption) GetPiVolumeRemoteCopyRelationshipResultOutput

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

    public static class GetPiVolumeRemoteCopyRelationship 
{
    public static Task<GetPiVolumeRemoteCopyRelationshipResult> InvokeAsync(GetPiVolumeRemoteCopyRelationshipArgs args, InvokeOptions? opts = null)
    public static Output<GetPiVolumeRemoteCopyRelationshipResult> Invoke(GetPiVolumeRemoteCopyRelationshipInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPiVolumeRemoteCopyRelationshipResult> getPiVolumeRemoteCopyRelationship(GetPiVolumeRemoteCopyRelationshipArgs args, InvokeOptions options)
public static Output<GetPiVolumeRemoteCopyRelationshipResult> getPiVolumeRemoteCopyRelationship(GetPiVolumeRemoteCopyRelationshipArgs args, InvokeOptions options)

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

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiVolumeId string
    The ID of the volume for which you want to retrieve detailed information.
    Id string
    (String) The unique identifier of the volume.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiVolumeId string
    The ID of the volume for which you want to retrieve detailed information.
    Id string
    (String) The unique identifier of the volume.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piVolumeId String
    The ID of the volume for which you want to retrieve detailed information.
    id String
    (String) The unique identifier of the volume.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piVolumeId string
    The ID of the volume for which you want to retrieve detailed information.
    id string
    (String) The unique identifier of the volume.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_volume_id str
    The ID of the volume for which you want to retrieve detailed information.
    id str
    (String) The unique identifier of the volume.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piVolumeId String
    The ID of the volume for which you want to retrieve detailed information.
    id String
    (String) The unique identifier of the volume.

    getPiVolumeRemoteCopyRelationship Result

    The following output properties are available:

    AuxiliaryChangedVolumeName string
    (String) The name of the volume that is acting as the auxiliary change volume for the relationship.
    AuxiliaryVolumeName string
    (String) The auxiliary volume name at storage host level.
    ConsistencyGroupName string
    (String) The consistency group name if volume is a part of volume group.
    CopyType string
    (String) The copy type.
    CyclePeriodSeconds double
    (Integer) The minimum period in seconds between multiple cycles.
    CyclingMode string
    (String) The type of cycling mode used.
    FreezeTime string
    (String) The freeze time of remote copy relationship.
    Id string
    (String) The unique identifier of the volume.
    MasterChangedVolumeName string
    (String) The name of the volume that is acting as the master change volume for the relationship.
    MasterVolumeName string
    (String) The master volume name at storage host level.
    Name string
    (String) The remote copy relationship name.
    PiCloudInstanceId string
    PiVolumeId string
    PrimaryRole string
    (String) Indicates whether master/aux volume is playing the primary role.
    Progress double
    (Integer) The relationship progress.
    RemoteCopyId string
    (String) The remote copy relationship ID.
    State string
    (String) The relationship state.
    Synchronized string
    (String) Indicates whether the relationship is synchronized.
    AuxiliaryChangedVolumeName string
    (String) The name of the volume that is acting as the auxiliary change volume for the relationship.
    AuxiliaryVolumeName string
    (String) The auxiliary volume name at storage host level.
    ConsistencyGroupName string
    (String) The consistency group name if volume is a part of volume group.
    CopyType string
    (String) The copy type.
    CyclePeriodSeconds float64
    (Integer) The minimum period in seconds between multiple cycles.
    CyclingMode string
    (String) The type of cycling mode used.
    FreezeTime string
    (String) The freeze time of remote copy relationship.
    Id string
    (String) The unique identifier of the volume.
    MasterChangedVolumeName string
    (String) The name of the volume that is acting as the master change volume for the relationship.
    MasterVolumeName string
    (String) The master volume name at storage host level.
    Name string
    (String) The remote copy relationship name.
    PiCloudInstanceId string
    PiVolumeId string
    PrimaryRole string
    (String) Indicates whether master/aux volume is playing the primary role.
    Progress float64
    (Integer) The relationship progress.
    RemoteCopyId string
    (String) The remote copy relationship ID.
    State string
    (String) The relationship state.
    Synchronized string
    (String) Indicates whether the relationship is synchronized.
    auxiliaryChangedVolumeName String
    (String) The name of the volume that is acting as the auxiliary change volume for the relationship.
    auxiliaryVolumeName String
    (String) The auxiliary volume name at storage host level.
    consistencyGroupName String
    (String) The consistency group name if volume is a part of volume group.
    copyType String
    (String) The copy type.
    cyclePeriodSeconds Double
    (Integer) The minimum period in seconds between multiple cycles.
    cyclingMode String
    (String) The type of cycling mode used.
    freezeTime String
    (String) The freeze time of remote copy relationship.
    id String
    (String) The unique identifier of the volume.
    masterChangedVolumeName String
    (String) The name of the volume that is acting as the master change volume for the relationship.
    masterVolumeName String
    (String) The master volume name at storage host level.
    name String
    (String) The remote copy relationship name.
    piCloudInstanceId String
    piVolumeId String
    primaryRole String
    (String) Indicates whether master/aux volume is playing the primary role.
    progress Double
    (Integer) The relationship progress.
    remoteCopyId String
    (String) The remote copy relationship ID.
    state String
    (String) The relationship state.
    synchronized_ String
    (String) Indicates whether the relationship is synchronized.
    auxiliaryChangedVolumeName string
    (String) The name of the volume that is acting as the auxiliary change volume for the relationship.
    auxiliaryVolumeName string
    (String) The auxiliary volume name at storage host level.
    consistencyGroupName string
    (String) The consistency group name if volume is a part of volume group.
    copyType string
    (String) The copy type.
    cyclePeriodSeconds number
    (Integer) The minimum period in seconds between multiple cycles.
    cyclingMode string
    (String) The type of cycling mode used.
    freezeTime string
    (String) The freeze time of remote copy relationship.
    id string
    (String) The unique identifier of the volume.
    masterChangedVolumeName string
    (String) The name of the volume that is acting as the master change volume for the relationship.
    masterVolumeName string
    (String) The master volume name at storage host level.
    name string
    (String) The remote copy relationship name.
    piCloudInstanceId string
    piVolumeId string
    primaryRole string
    (String) Indicates whether master/aux volume is playing the primary role.
    progress number
    (Integer) The relationship progress.
    remoteCopyId string
    (String) The remote copy relationship ID.
    state string
    (String) The relationship state.
    synchronized string
    (String) Indicates whether the relationship is synchronized.
    auxiliary_changed_volume_name str
    (String) The name of the volume that is acting as the auxiliary change volume for the relationship.
    auxiliary_volume_name str
    (String) The auxiliary volume name at storage host level.
    consistency_group_name str
    (String) The consistency group name if volume is a part of volume group.
    copy_type str
    (String) The copy type.
    cycle_period_seconds float
    (Integer) The minimum period in seconds between multiple cycles.
    cycling_mode str
    (String) The type of cycling mode used.
    freeze_time str
    (String) The freeze time of remote copy relationship.
    id str
    (String) The unique identifier of the volume.
    master_changed_volume_name str
    (String) The name of the volume that is acting as the master change volume for the relationship.
    master_volume_name str
    (String) The master volume name at storage host level.
    name str
    (String) The remote copy relationship name.
    pi_cloud_instance_id str
    pi_volume_id str
    primary_role str
    (String) Indicates whether master/aux volume is playing the primary role.
    progress float
    (Integer) The relationship progress.
    remote_copy_id str
    (String) The remote copy relationship ID.
    state str
    (String) The relationship state.
    synchronized str
    (String) Indicates whether the relationship is synchronized.
    auxiliaryChangedVolumeName String
    (String) The name of the volume that is acting as the auxiliary change volume for the relationship.
    auxiliaryVolumeName String
    (String) The auxiliary volume name at storage host level.
    consistencyGroupName String
    (String) The consistency group name if volume is a part of volume group.
    copyType String
    (String) The copy type.
    cyclePeriodSeconds Number
    (Integer) The minimum period in seconds between multiple cycles.
    cyclingMode String
    (String) The type of cycling mode used.
    freezeTime String
    (String) The freeze time of remote copy relationship.
    id String
    (String) The unique identifier of the volume.
    masterChangedVolumeName String
    (String) The name of the volume that is acting as the master change volume for the relationship.
    masterVolumeName String
    (String) The master volume name at storage host level.
    name String
    (String) The remote copy relationship name.
    piCloudInstanceId String
    piVolumeId String
    primaryRole String
    (String) Indicates whether master/aux volume is playing the primary role.
    progress Number
    (Integer) The relationship progress.
    remoteCopyId String
    (String) The remote copy relationship ID.
    state String
    (String) The relationship state.
    synchronized String
    (String) Indicates whether the relationship is synchronized.

    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