powerstore.getVolumegroup

Start a Neo task

Explain and create a powerstore.getVolumegroup resource

powerstore 1.2.1 published on Thursday, Jun 26, 2025 by dell

dell/terraform-provider-powerstore

Using getVolumegroup

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 getVolumegroup(args: GetVolumegroupArgs, opts?: InvokeOptions): Promise<GetVolumegroupResult>
function getVolumegroupOutput(args: GetVolumegroupOutputArgs, opts?: InvokeOptions): Output<GetVolumegroupResult>

def get_volumegroup(filter_expression: Optional[str] = None,
                    id: Optional[str] = None,
                    name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetVolumegroupResult
def get_volumegroup_output(filter_expression: Optional[pulumi.Input[str]] = None,
                    id: Optional[pulumi.Input[str]] = None,
                    name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetVolumegroupResult]

func LookupVolumegroup(ctx *Context, args *LookupVolumegroupArgs, opts ...InvokeOption) (*LookupVolumegroupResult, error)
func LookupVolumegroupOutput(ctx *Context, args *LookupVolumegroupOutputArgs, opts ...InvokeOption) LookupVolumegroupResultOutput

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

public static class GetVolumegroup 
{
    public static Task<GetVolumegroupResult> InvokeAsync(GetVolumegroupArgs args, InvokeOptions? opts = null)
    public static Output<GetVolumegroupResult> Invoke(GetVolumegroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVolumegroupResult> getVolumegroup(GetVolumegroupArgs args, InvokeOptions options)
public static Output<GetVolumegroupResult> getVolumegroup(GetVolumegroupArgs args, InvokeOptions options)

fn::invoke:
  function: powerstore:index/getVolumegroup:getVolumegroup
  arguments:
    # arguments dictionary

The following arguments are supported:

FilterExpression string: PowerStore filter expression to filter Replication rules by. Conflicts with id and name.
Id string: Unique identifier of the volume group. Conflicts with name.
Name string: Volume group name. Conflicts with id.

FilterExpression string: PowerStore filter expression to filter Replication rules by. Conflicts with id and name.
Id string: Unique identifier of the volume group. Conflicts with name.
Name string: Volume group name. Conflicts with id.

filterExpression String: PowerStore filter expression to filter Replication rules by. Conflicts with id and name.
id String: Unique identifier of the volume group. Conflicts with name.
name String: Volume group name. Conflicts with id.

filterExpression string: PowerStore filter expression to filter Replication rules by. Conflicts with id and name.
id string: Unique identifier of the volume group. Conflicts with name.
name string: Volume group name. Conflicts with id.

filter_expression str: PowerStore filter expression to filter Replication rules by. Conflicts with id and name.
id str: Unique identifier of the volume group. Conflicts with name.
name str: Volume group name. Conflicts with id.

filterExpression String: PowerStore filter expression to filter Replication rules by. Conflicts with id and name.
id String: Unique identifier of the volume group. Conflicts with name.
name String: Volume group name. Conflicts with id.

getVolumegroup Result

The following output properties are available:

Id string: Unique identifier of the volume group. Conflicts with name.
VolumeGroups List<GetVolumegroupVolumeGroup>: List of volume groups.
FilterExpression string: PowerStore filter expression to filter Replication rules by. Conflicts with id and name.
Name string: Volume group name. Conflicts with id.

Id string: Unique identifier of the volume group. Conflicts with name.
VolumeGroups []GetVolumegroupVolumeGroup: List of volume groups.
FilterExpression string: PowerStore filter expression to filter Replication rules by. Conflicts with id and name.
Name string: Volume group name. Conflicts with id.

id String: Unique identifier of the volume group. Conflicts with name.
volumeGroups List<GetVolumegroupVolumeGroup>: List of volume groups.
filterExpression String: PowerStore filter expression to filter Replication rules by. Conflicts with id and name.
name String: Volume group name. Conflicts with id.

id string: Unique identifier of the volume group. Conflicts with name.
volumeGroups GetVolumegroupVolumeGroup[]: List of volume groups.
filterExpression string: PowerStore filter expression to filter Replication rules by. Conflicts with id and name.
name string: Volume group name. Conflicts with id.

id str: Unique identifier of the volume group. Conflicts with name.
volume_groups Sequence[GetVolumegroupVolumeGroup]: List of volume groups.
filter_expression str: PowerStore filter expression to filter Replication rules by. Conflicts with id and name.
name str: Volume group name. Conflicts with id.

id String: Unique identifier of the volume group. Conflicts with name.
volumeGroups List<Property Map>: List of volume groups.
filterExpression String: PowerStore filter expression to filter Replication rules by. Conflicts with id and name.
name String: Volume group name. Conflicts with id.

Supporting Types

GetVolumegroupVolumeGroup

CreationTimestamp string: The time at which the volume group was created.
Description string: Volume group description.
Id string: Unique identifier of the volume group.
IsImporting bool: Indicates whether the volume group is being imported.
IsProtectable bool: This is a derived field that is set internally.
IsReplicationDestination bool: Indicates whether this volume group is a replication destination.
IsWriteOrderConsistent bool: For a primary or a clone volume group, this property determines whether snapshot sets of the group will be write order consistent.
LocationHistories List<GetVolumegroupVolumeGroupLocationHistory>: Storage resource location history.
MigrationSession GetVolumegroupVolumeGroupMigrationSession: Properties of a migration session.
MigrationSessionId string: Unique identifier of the migration session assigned to the volume group when it is part of a migration activity.
Name string: Volume group name.
PlacementRule string: This is set during creation, and determines resource balancer recommendations.
ProtectionData GetVolumegroupVolumeGroupProtectionData: Specifies the ProtectionData associated with a volume group.
ProtectionPolicy GetVolumegroupVolumeGroupProtectionPolicy: Specifies the Protection Policy associated with a volume group.
ProtectionPolicyId string: Unique identifier of the protection policy assigned to the volume group.
Type string: Type of volume.
TypeL10n string: Localized message string corresponding to type
Volumes List<GetVolumegroupVolumeGroupVolume>: List of the volumes that are associated with this volume*group.

CreationTimestamp string: The time at which the volume group was created.
Description string: Volume group description.
Id string: Unique identifier of the volume group.
IsImporting bool: Indicates whether the volume group is being imported.
IsProtectable bool: This is a derived field that is set internally.
IsReplicationDestination bool: Indicates whether this volume group is a replication destination.
IsWriteOrderConsistent bool: For a primary or a clone volume group, this property determines whether snapshot sets of the group will be write order consistent.
LocationHistories []GetVolumegroupVolumeGroupLocationHistory: Storage resource location history.
MigrationSession GetVolumegroupVolumeGroupMigrationSession: Properties of a migration session.
MigrationSessionId string: Unique identifier of the migration session assigned to the volume group when it is part of a migration activity.
Name string: Volume group name.
PlacementRule string: This is set during creation, and determines resource balancer recommendations.
ProtectionData GetVolumegroupVolumeGroupProtectionData: Specifies the ProtectionData associated with a volume group.
ProtectionPolicy GetVolumegroupVolumeGroupProtectionPolicy: Specifies the Protection Policy associated with a volume group.
ProtectionPolicyId string: Unique identifier of the protection policy assigned to the volume group.
Type string: Type of volume.
TypeL10n string: Localized message string corresponding to type
Volumes []GetVolumegroupVolumeGroupVolume: List of the volumes that are associated with this volume*group.

creationTimestamp String: The time at which the volume group was created.
description String: Volume group description.
id String: Unique identifier of the volume group.
isImporting Boolean: Indicates whether the volume group is being imported.
isProtectable Boolean: This is a derived field that is set internally.
isReplicationDestination Boolean: Indicates whether this volume group is a replication destination.
isWriteOrderConsistent Boolean: For a primary or a clone volume group, this property determines whether snapshot sets of the group will be write order consistent.
locationHistories List<GetVolumegroupVolumeGroupLocationHistory>: Storage resource location history.
migrationSession GetVolumegroupVolumeGroupMigrationSession: Properties of a migration session.
migrationSessionId String: Unique identifier of the migration session assigned to the volume group when it is part of a migration activity.
name String: Volume group name.
placementRule String: This is set during creation, and determines resource balancer recommendations.
protectionData GetVolumegroupVolumeGroupProtectionData: Specifies the ProtectionData associated with a volume group.
protectionPolicy GetVolumegroupVolumeGroupProtectionPolicy: Specifies the Protection Policy associated with a volume group.
protectionPolicyId String: Unique identifier of the protection policy assigned to the volume group.
type String: Type of volume.
typeL10n String: Localized message string corresponding to type
volumes List<GetVolumegroupVolumeGroupVolume>: List of the volumes that are associated with this volume*group.

creationTimestamp string: The time at which the volume group was created.
description string: Volume group description.
id string: Unique identifier of the volume group.
isImporting boolean: Indicates whether the volume group is being imported.
isProtectable boolean: This is a derived field that is set internally.
isReplicationDestination boolean: Indicates whether this volume group is a replication destination.
isWriteOrderConsistent boolean: For a primary or a clone volume group, this property determines whether snapshot sets of the group will be write order consistent.
locationHistories GetVolumegroupVolumeGroupLocationHistory[]: Storage resource location history.
migrationSession GetVolumegroupVolumeGroupMigrationSession: Properties of a migration session.
migrationSessionId string: Unique identifier of the migration session assigned to the volume group when it is part of a migration activity.
name string: Volume group name.
placementRule string: This is set during creation, and determines resource balancer recommendations.
protectionData GetVolumegroupVolumeGroupProtectionData: Specifies the ProtectionData associated with a volume group.
protectionPolicy GetVolumegroupVolumeGroupProtectionPolicy: Specifies the Protection Policy associated with a volume group.
protectionPolicyId string: Unique identifier of the protection policy assigned to the volume group.
type string: Type of volume.
typeL10n string: Localized message string corresponding to type
volumes GetVolumegroupVolumeGroupVolume[]: List of the volumes that are associated with this volume*group.

creation_timestamp str: The time at which the volume group was created.
description str: Volume group description.
id str: Unique identifier of the volume group.
is_importing bool: Indicates whether the volume group is being imported.
is_protectable bool: This is a derived field that is set internally.
is_replication_destination bool: Indicates whether this volume group is a replication destination.
is_write_order_consistent bool: For a primary or a clone volume group, this property determines whether snapshot sets of the group will be write order consistent.
location_histories Sequence[GetVolumegroupVolumeGroupLocationHistory]: Storage resource location history.
migration_session GetVolumegroupVolumeGroupMigrationSession: Properties of a migration session.
migration_session_id str: Unique identifier of the migration session assigned to the volume group when it is part of a migration activity.
name str: Volume group name.
placement_rule str: This is set during creation, and determines resource balancer recommendations.
protection_data GetVolumegroupVolumeGroupProtectionData: Specifies the ProtectionData associated with a volume group.
protection_policy GetVolumegroupVolumeGroupProtectionPolicy: Specifies the Protection Policy associated with a volume group.
protection_policy_id str: Unique identifier of the protection policy assigned to the volume group.
type str: Type of volume.
type_l10n str: Localized message string corresponding to type
volumes Sequence[GetVolumegroupVolumeGroupVolume]: List of the volumes that are associated with this volume*group.

creationTimestamp String: The time at which the volume group was created.
description String: Volume group description.
id String: Unique identifier of the volume group.
isImporting Boolean: Indicates whether the volume group is being imported.
isProtectable Boolean: This is a derived field that is set internally.
isReplicationDestination Boolean: Indicates whether this volume group is a replication destination.
isWriteOrderConsistent Boolean: For a primary or a clone volume group, this property determines whether snapshot sets of the group will be write order consistent.
locationHistories List<Property Map>: Storage resource location history.
migrationSession Property Map: Properties of a migration session.
migrationSessionId String: Unique identifier of the migration session assigned to the volume group when it is part of a migration activity.
name String: Volume group name.
placementRule String: This is set during creation, and determines resource balancer recommendations.
protectionData Property Map: Specifies the ProtectionData associated with a volume group.
protectionPolicy Property Map: Specifies the Protection Policy associated with a volume group.
protectionPolicyId String: Unique identifier of the protection policy assigned to the volume group.
type String: Type of volume.
typeL10n String: Localized message string corresponding to type
volumes List<Property Map>: List of the volumes that are associated with this volume*group.

GetVolumegroupVolumeGroupLocationHistory

FromApplianceId string: Unique identifier of the appliance from which the volume was relocated.
ToApplianceId string: Unique identifier of the appliance to which the volume was relocated.

FromApplianceId string: Unique identifier of the appliance from which the volume was relocated.
ToApplianceId string: Unique identifier of the appliance to which the volume was relocated.

fromApplianceId String: Unique identifier of the appliance from which the volume was relocated.
toApplianceId String: Unique identifier of the appliance to which the volume was relocated.

fromApplianceId string: Unique identifier of the appliance from which the volume was relocated.
toApplianceId string: Unique identifier of the appliance to which the volume was relocated.

from_appliance_id str: Unique identifier of the appliance from which the volume was relocated.
to_appliance_id str: Unique identifier of the appliance to which the volume was relocated.

fromApplianceId String: Unique identifier of the appliance from which the volume was relocated.
toApplianceId String: Unique identifier of the appliance to which the volume was relocated.