powerstore 1.2.1, Jun 26 25

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

powerstore.getVolume

Start a Neo task

Explain and create a powerstore.getVolume resource

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

dell/terraform-provider-powerstore

Using getVolume

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 getVolume(args: GetVolumeArgs, opts?: InvokeOptions): Promise<GetVolumeResult>
function getVolumeOutput(args: GetVolumeOutputArgs, opts?: InvokeOptions): Output<GetVolumeResult>

def get_volume(filter_expression: Optional[str] = None,
               id: Optional[str] = None,
               name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetVolumeResult
def get_volume_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[GetVolumeResult]

func LookupVolume(ctx *Context, args *LookupVolumeArgs, opts ...InvokeOption) (*LookupVolumeResult, error)
func LookupVolumeOutput(ctx *Context, args *LookupVolumeOutputArgs, opts ...InvokeOption) LookupVolumeResultOutput

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

public static class GetVolume 
{
    public static Task<GetVolumeResult> InvokeAsync(GetVolumeArgs args, InvokeOptions? opts = null)
    public static Output<GetVolumeResult> Invoke(GetVolumeInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)
public static Output<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)

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

The following arguments are supported:

FilterExpression string: PowerStore filter expression to filter Volumes by. Conflicts with id and name.
Id string: Unique identifier of the volume instance.
Name string: Name of the volume.

FilterExpression string: PowerStore filter expression to filter Volumes by. Conflicts with id and name.
Id string: Unique identifier of the volume instance.
Name string: Name of the volume.

filterExpression String: PowerStore filter expression to filter Volumes by. Conflicts with id and name.
id String: Unique identifier of the volume instance.
name String: Name of the volume.

filterExpression string: PowerStore filter expression to filter Volumes by. Conflicts with id and name.
id string: Unique identifier of the volume instance.
name string: Name of the volume.

filter_expression str: PowerStore filter expression to filter Volumes by. Conflicts with id and name.
id str: Unique identifier of the volume instance.
name str: Name of the volume.

filterExpression String: PowerStore filter expression to filter Volumes by. Conflicts with id and name.
id String: Unique identifier of the volume instance.
name String: Name of the volume.

getVolume Result

The following output properties are available:

Id string: Unique identifier of the volume instance.
Volumes List<GetVolumeVolume>: List of volumes.
FilterExpression string: PowerStore filter expression to filter Volumes by. Conflicts with id and name.
Name string: Name of the volume.

Id string: Unique identifier of the volume instance.
Volumes []GetVolumeVolume: List of volumes.
FilterExpression string: PowerStore filter expression to filter Volumes by. Conflicts with id and name.
Name string: Name of the volume.

id String: Unique identifier of the volume instance.
volumes List<GetVolumeVolume>: List of volumes.
filterExpression String: PowerStore filter expression to filter Volumes by. Conflicts with id and name.
name String: Name of the volume.

id string: Unique identifier of the volume instance.
volumes GetVolumeVolume[]: List of volumes.
filterExpression string: PowerStore filter expression to filter Volumes by. Conflicts with id and name.
name string: Name of the volume.

id str: Unique identifier of the volume instance.
volumes Sequence[GetVolumeVolume]: List of volumes.
filter_expression str: PowerStore filter expression to filter Volumes by. Conflicts with id and name.
name str: Name of the volume.

id String: Unique identifier of the volume instance.
volumes List<Property Map>: List of volumes.
filterExpression String: PowerStore filter expression to filter Volumes by. Conflicts with id and name.
name String: Name of the volume.

Supporting Types

GetVolumeVolume

AppType string: The app type of the volume.
AppTypeL10n string: Localized message string corresponding to app type
AppTypeOther string: The app type other of the volume.
Appliance GetVolumeVolumeAppliance: Specifies the Appliance associated for a volume.
ApplianceId string: Unique identifier of the appliance on which the volume is provisioned.
CapacityUnit string: The Capacity Unit corresponding to the size.
CreationTimestamp string: The creation timestamp of the volume.
Datastores List<GetVolumeVolumeDatastore>: Specifies the Datastores for a volume.
Description string: The description of the volume.
HostGroupId string: The host group id of the volume.
HostId string: The host id of the volume.
Id string: The ID of the volume.
IsHostAccessAvailable bool: Indicates whether the volume is available to host
IsReplicationDestination bool: Indicates whether this volume is a replication destination.
LocationHistories List<GetVolumeVolumeLocationHistory>: Specifies the LocationHistory for a volume.
LogicalUnitNumber double: The current amount of data written to the volume
LogicalUsed double: Current amount of data used by the volume.
MappedVolumes List<GetVolumeVolumeMappedVolume>: Specifies the MappedVolumes associated with a volume.
MetroReplicationSessionId string: Unique identifier of the replication session assigned to the volume
MigrationSession GetVolumeVolumeMigrationSession: Specifies the MigrationSession associated for a volume.
MigrationSessionId string: Unique identifier of the migration session assigned to the volume
Name string: Name of the volume.
Nguid string: The nguid of the volume.
NodeAffinity string: The node affinity of the volume.
NodeAffinityL10n string: Localized message string corresponding to node affinity
Nsid double: The nsid of the volume.
PerformancePolicyId string: The performance policy assigned to the volume.
ProtectionData GetVolumeVolumeProtectionData: Specifies the ProtectionData associated with a volume.
ProtectionPolicy GetVolumeVolumeProtectionPolicy: Specifies the protection policy associated for a volume.
ProtectionPolicyId string: The protection policy assigned to the volume.
Size double: The size of the volume.
State string: The state of the volume.
StateL10n string: Localized message string corresponding to state
Type string: The type of the volume.
TypeL10n string: Localized message string corresponding to type
VolumeGroupId string: The volume group id of the volume.
VolumeGroups List<GetVolumeVolumeVolumeGroup>: Specifies the VolumeGroup for a volume.
Wwn string: The wwn of the volume.

AppType string: The app type of the volume.
AppTypeL10n string: Localized message string corresponding to app type
AppTypeOther string: The app type other of the volume.
Appliance GetVolumeVolumeAppliance: Specifies the Appliance associated for a volume.
ApplianceId string: Unique identifier of the appliance on which the volume is provisioned.
CapacityUnit string: The Capacity Unit corresponding to the size.
CreationTimestamp string: The creation timestamp of the volume.
Datastores []GetVolumeVolumeDatastore: Specifies the Datastores for a volume.
Description string: The description of the volume.
HostGroupId string: The host group id of the volume.
HostId string: The host id of the volume.
Id string: The ID of the volume.
IsHostAccessAvailable bool: Indicates whether the volume is available to host
IsReplicationDestination bool: Indicates whether this volume is a replication destination.
LocationHistories []GetVolumeVolumeLocationHistory: Specifies the LocationHistory for a volume.
LogicalUnitNumber float64: The current amount of data written to the volume
LogicalUsed float64: Current amount of data used by the volume.
MappedVolumes []GetVolumeVolumeMappedVolume: Specifies the MappedVolumes associated with a volume.
MetroReplicationSessionId string: Unique identifier of the replication session assigned to the volume
MigrationSession GetVolumeVolumeMigrationSession: Specifies the MigrationSession associated for a volume.
MigrationSessionId string: Unique identifier of the migration session assigned to the volume
Name string: Name of the volume.
Nguid string: The nguid of the volume.
NodeAffinity string: The node affinity of the volume.
NodeAffinityL10n string: Localized message string corresponding to node affinity
Nsid float64: The nsid of the volume.
PerformancePolicyId string: The performance policy assigned to the volume.
ProtectionData GetVolumeVolumeProtectionData: Specifies the ProtectionData associated with a volume.
ProtectionPolicy GetVolumeVolumeProtectionPolicy: Specifies the protection policy associated for a volume.
ProtectionPolicyId string: The protection policy assigned to the volume.
Size float64: The size of the volume.
State string: The state of the volume.
StateL10n string: Localized message string corresponding to state
Type string: The type of the volume.
TypeL10n string: Localized message string corresponding to type
VolumeGroupId string: The volume group id of the volume.
VolumeGroups []GetVolumeVolumeVolumeGroup: Specifies the VolumeGroup for a volume.
Wwn string: The wwn of the volume.

appType String: The app type of the volume.
appTypeL10n String: Localized message string corresponding to app type
appTypeOther String: The app type other of the volume.
appliance GetVolumeVolumeAppliance: Specifies the Appliance associated for a volume.
applianceId String: Unique identifier of the appliance on which the volume is provisioned.
capacityUnit String: The Capacity Unit corresponding to the size.
creationTimestamp String: The creation timestamp of the volume.
datastores List<GetVolumeVolumeDatastore>: Specifies the Datastores for a volume.
description String: The description of the volume.
hostGroupId String: The host group id of the volume.
hostId String: The host id of the volume.
id String: The ID of the volume.
isHostAccessAvailable Boolean: Indicates whether the volume is available to host
isReplicationDestination Boolean: Indicates whether this volume is a replication destination.
locationHistories List<GetVolumeVolumeLocationHistory>: Specifies the LocationHistory for a volume.
logicalUnitNumber Double: The current amount of data written to the volume
logicalUsed Double: Current amount of data used by the volume.
mappedVolumes List<GetVolumeVolumeMappedVolume>: Specifies the MappedVolumes associated with a volume.
metroReplicationSessionId String: Unique identifier of the replication session assigned to the volume
migrationSession GetVolumeVolumeMigrationSession: Specifies the MigrationSession associated for a volume.
migrationSessionId String: Unique identifier of the migration session assigned to the volume
name String: Name of the volume.
nguid String: The nguid of the volume.
nodeAffinity String: The node affinity of the volume.
nodeAffinityL10n String: Localized message string corresponding to node affinity
nsid Double: The nsid of the volume.
performancePolicyId String: The performance policy assigned to the volume.
protectionData GetVolumeVolumeProtectionData: Specifies the ProtectionData associated with a volume.
protectionPolicy GetVolumeVolumeProtectionPolicy: Specifies the protection policy associated for a volume.
protectionPolicyId String: The protection policy assigned to the volume.
size Double: The size of the volume.
state String: The state of the volume.
stateL10n String: Localized message string corresponding to state
type String: The type of the volume.
typeL10n String: Localized message string corresponding to type
volumeGroupId String: The volume group id of the volume.
volumeGroups List<GetVolumeVolumeVolumeGroup>: Specifies the VolumeGroup for a volume.
wwn String: The wwn of the volume.

appType string: The app type of the volume.
appTypeL10n string: Localized message string corresponding to app type
appTypeOther string: The app type other of the volume.
appliance GetVolumeVolumeAppliance: Specifies the Appliance associated for a volume.
applianceId string: Unique identifier of the appliance on which the volume is provisioned.
capacityUnit string: The Capacity Unit corresponding to the size.
creationTimestamp string: The creation timestamp of the volume.
datastores GetVolumeVolumeDatastore[]: Specifies the Datastores for a volume.
description string: The description of the volume.
hostGroupId string: The host group id of the volume.
hostId string: The host id of the volume.
id string: The ID of the volume.
isHostAccessAvailable boolean: Indicates whether the volume is available to host
isReplicationDestination boolean: Indicates whether this volume is a replication destination.
locationHistories GetVolumeVolumeLocationHistory[]: Specifies the LocationHistory for a volume.
logicalUnitNumber number: The current amount of data written to the volume
logicalUsed number: Current amount of data used by the volume.
mappedVolumes GetVolumeVolumeMappedVolume[]: Specifies the MappedVolumes associated with a volume.
metroReplicationSessionId string: Unique identifier of the replication session assigned to the volume
migrationSession GetVolumeVolumeMigrationSession: Specifies the MigrationSession associated for a volume.
migrationSessionId string: Unique identifier of the migration session assigned to the volume
name string: Name of the volume.
nguid string: The nguid of the volume.
nodeAffinity string: The node affinity of the volume.
nodeAffinityL10n string: Localized message string corresponding to node affinity
nsid number: The nsid of the volume.
performancePolicyId string: The performance policy assigned to the volume.
protectionData GetVolumeVolumeProtectionData: Specifies the ProtectionData associated with a volume.
protectionPolicy GetVolumeVolumeProtectionPolicy: Specifies the protection policy associated for a volume.
protectionPolicyId string: The protection policy assigned to the volume.
size number: The size of the volume.
state string: The state of the volume.
stateL10n string: Localized message string corresponding to state
type string: The type of the volume.
typeL10n string: Localized message string corresponding to type
volumeGroupId string: The volume group id of the volume.
volumeGroups GetVolumeVolumeVolumeGroup[]: Specifies the VolumeGroup for a volume.
wwn string: The wwn of the volume.

app_type str: The app type of the volume.
app_type_l10n str: Localized message string corresponding to app type
app_type_other str: The app type other of the volume.
appliance GetVolumeVolumeAppliance: Specifies the Appliance associated for a volume.
appliance_id str: Unique identifier of the appliance on which the volume is provisioned.
capacity_unit str: The Capacity Unit corresponding to the size.
creation_timestamp str: The creation timestamp of the volume.
datastores Sequence[GetVolumeVolumeDatastore]: Specifies the Datastores for a volume.
description str: The description of the volume.
host_group_id str: The host group id of the volume.
host_id str: The host id of the volume.
id str: The ID of the volume.
is_host_access_available bool: Indicates whether the volume is available to host
is_replication_destination bool: Indicates whether this volume is a replication destination.
location_histories Sequence[GetVolumeVolumeLocationHistory]: Specifies the LocationHistory for a volume.
logical_unit_number float: The current amount of data written to the volume
logical_used float: Current amount of data used by the volume.
mapped_volumes Sequence[GetVolumeVolumeMappedVolume]: Specifies the MappedVolumes associated with a volume.
metro_replication_session_id str: Unique identifier of the replication session assigned to the volume
migration_session GetVolumeVolumeMigrationSession: Specifies the MigrationSession associated for a volume.
migration_session_id str: Unique identifier of the migration session assigned to the volume
name str: Name of the volume.
nguid str: The nguid of the volume.
node_affinity str: The node affinity of the volume.
node_affinity_l10n str: Localized message string corresponding to node affinity
nsid float: The nsid of the volume.
performance_policy_id str: The performance policy assigned to the volume.
protection_data GetVolumeVolumeProtectionData: Specifies the ProtectionData associated with a volume.
protection_policy GetVolumeVolumeProtectionPolicy: Specifies the protection policy associated for a volume.
protection_policy_id str: The protection policy assigned to the volume.
size float: The size of the volume.
state str: The state of the volume.
state_l10n str: Localized message string corresponding to state
type str: The type of the volume.
type_l10n str: Localized message string corresponding to type
volume_group_id str: The volume group id of the volume.
volume_groups Sequence[GetVolumeVolumeVolumeGroup]: Specifies the VolumeGroup for a volume.
wwn str: The wwn of the volume.

appType String: The app type of the volume.
appTypeL10n String: Localized message string corresponding to app type
appTypeOther String: The app type other of the volume.
appliance Property Map: Specifies the Appliance associated for a volume.
applianceId String: Unique identifier of the appliance on which the volume is provisioned.
capacityUnit String: The Capacity Unit corresponding to the size.
creationTimestamp String: The creation timestamp of the volume.
datastores List<Property Map>: Specifies the Datastores for a volume.
description String: The description of the volume.
hostGroupId String: The host group id of the volume.
hostId String: The host id of the volume.
id String: The ID of the volume.
isHostAccessAvailable Boolean: Indicates whether the volume is available to host
isReplicationDestination Boolean: Indicates whether this volume is a replication destination.
locationHistories List<Property Map>: Specifies the LocationHistory for a volume.
logicalUnitNumber Number: The current amount of data written to the volume
logicalUsed Number: Current amount of data used by the volume.
mappedVolumes List<Property Map>: Specifies the MappedVolumes associated with a volume.
metroReplicationSessionId String: Unique identifier of the replication session assigned to the volume
migrationSession Property Map: Specifies the MigrationSession associated for a volume.
migrationSessionId String: Unique identifier of the migration session assigned to the volume
name String: Name of the volume.
nguid String: The nguid of the volume.
nodeAffinity String: The node affinity of the volume.
nodeAffinityL10n String: Localized message string corresponding to node affinity
nsid Number: The nsid of the volume.
performancePolicyId String: The performance policy assigned to the volume.
protectionData Property Map: Specifies the ProtectionData associated with a volume.
protectionPolicy Property Map: Specifies the protection policy associated for a volume.
protectionPolicyId String: The protection policy assigned to the volume.
size Number: The size of the volume.
state String: The state of the volume.
stateL10n String: Localized message string corresponding to state
type String: The type of the volume.
typeL10n String: Localized message string corresponding to type
volumeGroupId String: The volume group id of the volume.
volumeGroups List<Property Map>: Specifies the VolumeGroup for a volume.
wwn String: The wwn of the volume.

GetVolumeVolumeAppliance

Id string
Name string
ServiceTag string

Id string
Name string
ServiceTag string

id String
name String
serviceTag String

id string
name string
serviceTag string

id str
name str
service_tag str

id String
name String
serviceTag String

GetVolumeVolumeDatastore

Id string: Unique identifier of the datastore instance.
InstanceUuid string: UUID instance of the datastore in vCenter.
Name string: User-assigned name of the datastore in vCenter.

Id string: Unique identifier of the datastore instance.
InstanceUuid string: UUID instance of the datastore in vCenter.
Name string: User-assigned name of the datastore in vCenter.

id String: Unique identifier of the datastore instance.
instanceUuid String: UUID instance of the datastore in vCenter.
name String: User-assigned name of the datastore in vCenter.

id string: Unique identifier of the datastore instance.
instanceUuid string: UUID instance of the datastore in vCenter.
name string: User-assigned name of the datastore in vCenter.

id str: Unique identifier of the datastore instance.
instance_uuid str: UUID instance of the datastore in vCenter.
name str: User-assigned name of the datastore in vCenter.

id String: Unique identifier of the datastore instance.
instanceUuid String: UUID instance of the datastore in vCenter.
name String: User-assigned name of the datastore in vCenter.

GetVolumeVolumeLocationHistory

FromApplianceId string: Unique identifier of the appliance from which the volume was relocated.
MigratedOn string: Time when the storage resource location changed.
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.
MigratedOn string: Time when the storage resource location changed.
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.
migratedOn String: Time when the storage resource location changed.
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.
migratedOn string: Time when the storage resource location changed.
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.
migrated_on str: Time when the storage resource location changed.
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.
migratedOn String: Time when the storage resource location changed.
toApplianceId String: Unique identifier of the appliance to which the volume was relocated.