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

ibm.getPiVolumeGroupStorageDetails

Explore with Pulumi AI

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

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

    Example Usage

    The following example retrieves information about the storage details of a volume group that is present in Power Systems Virtual Server.

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const dsVolumeGroupStorageDetails = ibm.getPiVolumeGroupStorageDetails({
        piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
        piVolumeGroupId: "cf2ea8d3-cfc8-40e0-80c9-b096581be676",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    ds_volume_group_storage_details = ibm.get_pi_volume_group_storage_details(pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b",
        pi_volume_group_id="cf2ea8d3-cfc8-40e0-80c9-b096581be676")
    
    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.GetPiVolumeGroupStorageDetails(ctx, &ibm.GetPiVolumeGroupStorageDetailsArgs{
    			PiCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    			PiVolumeGroupId:   "cf2ea8d3-cfc8-40e0-80c9-b096581be676",
    		}, 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 dsVolumeGroupStorageDetails = Ibm.GetPiVolumeGroupStorageDetails.Invoke(new()
        {
            PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
            PiVolumeGroupId = "cf2ea8d3-cfc8-40e0-80c9-b096581be676",
        });
    
    });
    
    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.GetPiVolumeGroupStorageDetailsArgs;
    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 dsVolumeGroupStorageDetails = IbmFunctions.getPiVolumeGroupStorageDetails(GetPiVolumeGroupStorageDetailsArgs.builder()
                .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
                .piVolumeGroupId("cf2ea8d3-cfc8-40e0-80c9-b096581be676")
                .build());
    
        }
    }
    
    variables:
      dsVolumeGroupStorageDetails:
        fn::invoke:
          function: ibm:getPiVolumeGroupStorageDetails
          arguments:
            piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b
            piVolumeGroupId: cf2ea8d3-cfc8-40e0-80c9-b096581be676
    

    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 getPiVolumeGroupStorageDetails

    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 getPiVolumeGroupStorageDetails(args: GetPiVolumeGroupStorageDetailsArgs, opts?: InvokeOptions): Promise<GetPiVolumeGroupStorageDetailsResult>
    function getPiVolumeGroupStorageDetailsOutput(args: GetPiVolumeGroupStorageDetailsOutputArgs, opts?: InvokeOptions): Output<GetPiVolumeGroupStorageDetailsResult>
    def get_pi_volume_group_storage_details(id: Optional[str] = None,
                                            pi_cloud_instance_id: Optional[str] = None,
                                            pi_volume_group_id: Optional[str] = None,
                                            opts: Optional[InvokeOptions] = None) -> GetPiVolumeGroupStorageDetailsResult
    def get_pi_volume_group_storage_details_output(id: Optional[pulumi.Input[str]] = None,
                                            pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                                            pi_volume_group_id: Optional[pulumi.Input[str]] = None,
                                            opts: Optional[InvokeOptions] = None) -> Output[GetPiVolumeGroupStorageDetailsResult]
    func GetPiVolumeGroupStorageDetails(ctx *Context, args *GetPiVolumeGroupStorageDetailsArgs, opts ...InvokeOption) (*GetPiVolumeGroupStorageDetailsResult, error)
    func GetPiVolumeGroupStorageDetailsOutput(ctx *Context, args *GetPiVolumeGroupStorageDetailsOutputArgs, opts ...InvokeOption) GetPiVolumeGroupStorageDetailsResultOutput

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

    public static class GetPiVolumeGroupStorageDetails 
    {
        public static Task<GetPiVolumeGroupStorageDetailsResult> InvokeAsync(GetPiVolumeGroupStorageDetailsArgs args, InvokeOptions? opts = null)
        public static Output<GetPiVolumeGroupStorageDetailsResult> Invoke(GetPiVolumeGroupStorageDetailsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPiVolumeGroupStorageDetailsResult> getPiVolumeGroupStorageDetails(GetPiVolumeGroupStorageDetailsArgs args, InvokeOptions options)
    public static Output<GetPiVolumeGroupStorageDetailsResult> getPiVolumeGroupStorageDetails(GetPiVolumeGroupStorageDetailsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getPiVolumeGroupStorageDetails:getPiVolumeGroupStorageDetails
      arguments:
        # arguments dictionary

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiVolumeGroupId string
    The ID of the volume group.
    Id string
    (String) The unique identifier of the volume group.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiVolumeGroupId string
    The ID of the volume group.
    Id string
    (String) The unique identifier of the volume group.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piVolumeGroupId String
    The ID of the volume group.
    id String
    (String) The unique identifier of the volume group.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piVolumeGroupId string
    The ID of the volume group.
    id string
    (String) The unique identifier of the volume group.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_volume_group_id str
    The ID of the volume group.
    id str
    (String) The unique identifier of the volume group.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piVolumeGroupId String
    The ID of the volume group.
    id String
    (String) The unique identifier of the volume group.

    getPiVolumeGroupStorageDetails Result

    The following output properties are available:

    ConsistencyGroupName string
    (String) The name of consistency group at storage controller level.
    CyclePeriodSeconds double
    (Integer) The minimum period in seconds between multiple cycles.
    CyclingMode string
    (String) The type of cycling mode used.
    Id string
    (String) The unique identifier of the volume group.
    NumberOfVolumes double
    (Integer) The number of volumes in volume group.
    PiCloudInstanceId string
    PiVolumeGroupId string
    PrimaryRole string
    (String) Indicates whether master/aux volume is playing the primary role.
    RemoteCopyRelationshipNames List<string>
    (List) List of remote-copy relationship names in a volume group.
    ReplicationType string
    (String) The type of replication (metro, global).
    State string
    (String) The relationship state.
    Synchronized string
    (String) Indicates whether the relationship is synchronized.
    ConsistencyGroupName string
    (String) The name of consistency group at storage controller level.
    CyclePeriodSeconds float64
    (Integer) The minimum period in seconds between multiple cycles.
    CyclingMode string
    (String) The type of cycling mode used.
    Id string
    (String) The unique identifier of the volume group.
    NumberOfVolumes float64
    (Integer) The number of volumes in volume group.
    PiCloudInstanceId string
    PiVolumeGroupId string
    PrimaryRole string
    (String) Indicates whether master/aux volume is playing the primary role.
    RemoteCopyRelationshipNames []string
    (List) List of remote-copy relationship names in a volume group.
    ReplicationType string
    (String) The type of replication (metro, global).
    State string
    (String) The relationship state.
    Synchronized string
    (String) Indicates whether the relationship is synchronized.
    consistencyGroupName String
    (String) The name of consistency group at storage controller level.
    cyclePeriodSeconds Double
    (Integer) The minimum period in seconds between multiple cycles.
    cyclingMode String
    (String) The type of cycling mode used.
    id String
    (String) The unique identifier of the volume group.
    numberOfVolumes Double
    (Integer) The number of volumes in volume group.
    piCloudInstanceId String
    piVolumeGroupId String
    primaryRole String
    (String) Indicates whether master/aux volume is playing the primary role.
    remoteCopyRelationshipNames List<String>
    (List) List of remote-copy relationship names in a volume group.
    replicationType String
    (String) The type of replication (metro, global).
    state String
    (String) The relationship state.
    synchronized_ String
    (String) Indicates whether the relationship is synchronized.
    consistencyGroupName string
    (String) The name of consistency group at storage controller level.
    cyclePeriodSeconds number
    (Integer) The minimum period in seconds between multiple cycles.
    cyclingMode string
    (String) The type of cycling mode used.
    id string
    (String) The unique identifier of the volume group.
    numberOfVolumes number
    (Integer) The number of volumes in volume group.
    piCloudInstanceId string
    piVolumeGroupId string
    primaryRole string
    (String) Indicates whether master/aux volume is playing the primary role.
    remoteCopyRelationshipNames string[]
    (List) List of remote-copy relationship names in a volume group.
    replicationType string
    (String) The type of replication (metro, global).
    state string
    (String) The relationship state.
    synchronized string
    (String) Indicates whether the relationship is synchronized.
    consistency_group_name str
    (String) The name of consistency group at storage controller level.
    cycle_period_seconds float
    (Integer) The minimum period in seconds between multiple cycles.
    cycling_mode str
    (String) The type of cycling mode used.
    id str
    (String) The unique identifier of the volume group.
    number_of_volumes float
    (Integer) The number of volumes in volume group.
    pi_cloud_instance_id str
    pi_volume_group_id str
    primary_role str
    (String) Indicates whether master/aux volume is playing the primary role.
    remote_copy_relationship_names Sequence[str]
    (List) List of remote-copy relationship names in a volume group.
    replication_type str
    (String) The type of replication (metro, global).
    state str
    (String) The relationship state.
    synchronized str
    (String) Indicates whether the relationship is synchronized.
    consistencyGroupName String
    (String) The name of consistency group at storage controller level.
    cyclePeriodSeconds Number
    (Integer) The minimum period in seconds between multiple cycles.
    cyclingMode String
    (String) The type of cycling mode used.
    id String
    (String) The unique identifier of the volume group.
    numberOfVolumes Number
    (Integer) The number of volumes in volume group.
    piCloudInstanceId String
    piVolumeGroupId String
    primaryRole String
    (String) Indicates whether master/aux volume is playing the primary role.
    remoteCopyRelationshipNames List<String>
    (List) List of remote-copy relationship names in a volume group.
    replicationType String
    (String) The type of replication (metro, global).
    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