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

ibm.getPiVolumeGroups

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 all volume groups. about managing a volume group, see moving data to the cloud.

Example Usage

The following example retrieves information about all volume groups present in Power Systems Virtual Server.

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

const dsVolumeGroups = ibm.getPiVolumeGroups({
    piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
});
Copy
import pulumi
import pulumi_ibm as ibm

ds_volume_groups = ibm.get_pi_volume_groups(pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b")
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.GetPiVolumeGroups(ctx, &ibm.GetPiVolumeGroupsArgs{
			PiCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
		}, 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 dsVolumeGroups = Ibm.GetPiVolumeGroups.Invoke(new()
    {
        PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    });

});
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.GetPiVolumeGroupsArgs;
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 dsVolumeGroups = IbmFunctions.getPiVolumeGroups(GetPiVolumeGroupsArgs.builder()
            .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
            .build());

    }
}
Copy
variables:
  dsVolumeGroups:
    fn::invoke:
      function: ibm:getPiVolumeGroups
      arguments:
        piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b
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 getPiVolumeGroups

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 getPiVolumeGroups(args: GetPiVolumeGroupsArgs, opts?: InvokeOptions): Promise<GetPiVolumeGroupsResult>
function getPiVolumeGroupsOutput(args: GetPiVolumeGroupsOutputArgs, opts?: InvokeOptions): Output<GetPiVolumeGroupsResult>
Copy
def get_pi_volume_groups(id: Optional[str] = None,
                         pi_cloud_instance_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetPiVolumeGroupsResult
def get_pi_volume_groups_output(id: Optional[pulumi.Input[str]] = None,
                         pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetPiVolumeGroupsResult]
Copy
func GetPiVolumeGroups(ctx *Context, args *GetPiVolumeGroupsArgs, opts ...InvokeOption) (*GetPiVolumeGroupsResult, error)
func GetPiVolumeGroupsOutput(ctx *Context, args *GetPiVolumeGroupsOutputArgs, opts ...InvokeOption) GetPiVolumeGroupsResultOutput
Copy

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

public static class GetPiVolumeGroups 
{
    public static Task<GetPiVolumeGroupsResult> InvokeAsync(GetPiVolumeGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetPiVolumeGroupsResult> Invoke(GetPiVolumeGroupsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPiVolumeGroupsResult> getPiVolumeGroups(GetPiVolumeGroupsArgs args, InvokeOptions options)
public static Output<GetPiVolumeGroupsResult> getPiVolumeGroups(GetPiVolumeGroupsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getPiVolumeGroups:getPiVolumeGroups
  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.
Id string
(String) The unique identifier of the volume group.
PiCloudInstanceId This property is required. string
The GUID of the service instance associated with an account.
Id string
(String) The unique identifier of the volume group.
piCloudInstanceId This property is required. String
The GUID of the service instance associated with an account.
id String
(String) The unique identifier of the volume group.
piCloudInstanceId This property is required. string
The GUID of the service instance associated with an account.
id string
(String) The unique identifier of the volume group.
pi_cloud_instance_id This property is required. str
The GUID of the service instance associated with an account.
id str
(String) The unique identifier of the volume group.
piCloudInstanceId This property is required. String
The GUID of the service instance associated with an account.
id String
(String) The unique identifier of the volume group.

getPiVolumeGroups Result

The following output properties are available:

Id string
(String) The unique identifier of the volume group.
PiCloudInstanceId string
VolumeGroups List<GetPiVolumeGroupsVolumeGroup>
List of all volume groups.
Id string
(String) The unique identifier of the volume group.
PiCloudInstanceId string
VolumeGroups []GetPiVolumeGroupsVolumeGroup
List of all volume groups.
id String
(String) The unique identifier of the volume group.
piCloudInstanceId String
volumeGroups List<GetPiVolumeGroupsVolumeGroup>
List of all volume groups.
id string
(String) The unique identifier of the volume group.
piCloudInstanceId string
volumeGroups GetPiVolumeGroupsVolumeGroup[]
List of all volume groups.
id str
(String) The unique identifier of the volume group.
pi_cloud_instance_id str
volume_groups Sequence[GetPiVolumeGroupsVolumeGroup]
List of all volume groups.
id String
(String) The unique identifier of the volume group.
piCloudInstanceId String
volumeGroups List<Property Map>
List of all volume groups.

Supporting Types

GetPiVolumeGroupsVolumeGroup

Auxiliary This property is required. bool
(Boolean) Indicates if the volume group is auxiliary.
ConsistencyGroupName This property is required. string
(String) The name of consistency group at storage controller level.
Id This property is required. string
(String) The unique identifier of the volume group.
ReplicationSites This property is required. List<string>
(List) Indicates the replication sites of the volume group.
ReplicationStatus This property is required. string
(String) The replication status of volume group.
Status This property is required. string
(String) The status of the volume group.
StatusDescriptionErrors This property is required. List<GetPiVolumeGroupsVolumeGroupStatusDescriptionError>
(List) The status details of the volume group.
StoragePool This property is required. string
(String) Storage pool of the volume group.
VolumeGroupName This property is required. string
(String) The name of the volume group.
Auxiliary This property is required. bool
(Boolean) Indicates if the volume group is auxiliary.
ConsistencyGroupName This property is required. string
(String) The name of consistency group at storage controller level.
Id This property is required. string
(String) The unique identifier of the volume group.
ReplicationSites This property is required. []string
(List) Indicates the replication sites of the volume group.
ReplicationStatus This property is required. string
(String) The replication status of volume group.
Status This property is required. string
(String) The status of the volume group.
StatusDescriptionErrors This property is required. []GetPiVolumeGroupsVolumeGroupStatusDescriptionError
(List) The status details of the volume group.
StoragePool This property is required. string
(String) Storage pool of the volume group.
VolumeGroupName This property is required. string
(String) The name of the volume group.
auxiliary This property is required. Boolean
(Boolean) Indicates if the volume group is auxiliary.
consistencyGroupName This property is required. String
(String) The name of consistency group at storage controller level.
id This property is required. String
(String) The unique identifier of the volume group.
replicationSites This property is required. List<String>
(List) Indicates the replication sites of the volume group.
replicationStatus This property is required. String
(String) The replication status of volume group.
status This property is required. String
(String) The status of the volume group.
statusDescriptionErrors This property is required. List<GetPiVolumeGroupsVolumeGroupStatusDescriptionError>
(List) The status details of the volume group.
storagePool This property is required. String
(String) Storage pool of the volume group.
volumeGroupName This property is required. String
(String) The name of the volume group.
auxiliary This property is required. boolean
(Boolean) Indicates if the volume group is auxiliary.
consistencyGroupName This property is required. string
(String) The name of consistency group at storage controller level.
id This property is required. string
(String) The unique identifier of the volume group.
replicationSites This property is required. string[]
(List) Indicates the replication sites of the volume group.
replicationStatus This property is required. string
(String) The replication status of volume group.
status This property is required. string
(String) The status of the volume group.
statusDescriptionErrors This property is required. GetPiVolumeGroupsVolumeGroupStatusDescriptionError[]
(List) The status details of the volume group.
storagePool This property is required. string
(String) Storage pool of the volume group.
volumeGroupName This property is required. string
(String) The name of the volume group.
auxiliary This property is required. bool
(Boolean) Indicates if the volume group is auxiliary.
consistency_group_name This property is required. str
(String) The name of consistency group at storage controller level.
id This property is required. str
(String) The unique identifier of the volume group.
replication_sites This property is required. Sequence[str]
(List) Indicates the replication sites of the volume group.
replication_status This property is required. str
(String) The replication status of volume group.
status This property is required. str
(String) The status of the volume group.
status_description_errors This property is required. Sequence[GetPiVolumeGroupsVolumeGroupStatusDescriptionError]
(List) The status details of the volume group.
storage_pool This property is required. str
(String) Storage pool of the volume group.
volume_group_name This property is required. str
(String) The name of the volume group.
auxiliary This property is required. Boolean
(Boolean) Indicates if the volume group is auxiliary.
consistencyGroupName This property is required. String
(String) The name of consistency group at storage controller level.
id This property is required. String
(String) The unique identifier of the volume group.
replicationSites This property is required. List<String>
(List) Indicates the replication sites of the volume group.
replicationStatus This property is required. String
(String) The replication status of volume group.
status This property is required. String
(String) The status of the volume group.
statusDescriptionErrors This property is required. List<Property Map>
(List) The status details of the volume group.
storagePool This property is required. String
(String) Storage pool of the volume group.
volumeGroupName This property is required. String
(String) The name of the volume group.

GetPiVolumeGroupsVolumeGroupStatusDescriptionError

Key This property is required. string
(String) The volume group error key.
Message This property is required. string
(String) The failure message providing more details about the error key.
VolumeIds This property is required. List<string>
(List) List of volume IDs, which failed to be added/removed to/from the volume group, with the given error.
Key This property is required. string
(String) The volume group error key.
Message This property is required. string
(String) The failure message providing more details about the error key.
VolumeIds This property is required. []string
(List) List of volume IDs, which failed to be added/removed to/from the volume group, with the given error.
key This property is required. String
(String) The volume group error key.
message This property is required. String
(String) The failure message providing more details about the error key.
volumeIds This property is required. List<String>
(List) List of volume IDs, which failed to be added/removed to/from the volume group, with the given error.
key This property is required. string
(String) The volume group error key.
message This property is required. string
(String) The failure message providing more details about the error key.
volumeIds This property is required. string[]
(List) List of volume IDs, which failed to be added/removed to/from the volume group, with the given error.
key This property is required. str
(String) The volume group error key.
message This property is required. str
(String) The failure message providing more details about the error key.
volume_ids This property is required. Sequence[str]
(List) List of volume IDs, which failed to be added/removed to/from the volume group, with the given error.
key This property is required. String
(String) The volume group error key.
message This property is required. String
(String) The failure message providing more details about the error key.
volumeIds This property is required. List<String>
(List) List of volume IDs, which failed to be added/removed to/from the volume group, with the given error.

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