1. Packages
  2. Powerflex Provider
  3. API Docs
  4. getVolume
powerflex 1.8.0 published on Monday, Apr 14, 2025 by dell
dell/terraform-provider-powerflex

powerflex.getVolume

Start a Neo task
Explain and create a powerflex.getVolume resource
powerflex logo
powerflex 1.8.0 published on Monday, Apr 14, 2025 by dell
dell/terraform-provider-powerflex

    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: Optional[GetVolumeFilter] = None,
               opts: Optional[InvokeOptions] = None) -> GetVolumeResult
def get_volume_output(filter: Optional[pulumi.Input[GetVolumeFilterArgs]] = 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: powerflex:index/getVolume:getVolume
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getVolume Result

    The following output properties are available:

    Id string
    default datasource id
    Volumes List<GetVolumeVolume>
    List of volumes.
    Filter GetVolumeFilter
    Id string
    default datasource id
    Volumes []GetVolumeVolume
    List of volumes.
    Filter GetVolumeFilter
    id String
    default datasource id
    volumes List<GetVolumeVolume>
    List of volumes.
    filter GetVolumeFilter
    id string
    default datasource id
    volumes GetVolumeVolume[]
    List of volumes.
    filter GetVolumeFilter
    id str
    default datasource id
    volumes Sequence[GetVolumeVolume]
    List of volumes.
    filter GetVolumeFilter
    id String
    default datasource id
    volumes List<Property Map>
    List of volumes.
    filter Property Map

    Supporting Types

    GetVolumeFilter

    AccessModeLimits List<string>
    List of accessmodelimit
    AncestorVolumeIds List<string>
    List of ancestorvolumeid
    CompressionMethods List<string>
    List of compression_method
    ConsistencyGroupIds List<string>
    List of consistencygroupid
    CreationTimes List<double>
    List of creation_time
    DataLayouts List<string>
    List of data_layout
    Ids List<string>
    List of id
    LockedAutoSnapshot bool
    Value for lockedautosnapshot
    LockedAutoSnapshotMarkedForRemoval bool
    Value for lockedautosnapshotmarkedfor_removal
    ManagedBies List<string>
    List of managed_by
    Names List<string>
    List of name
    NotGenuineSnapshot bool
    Value for notgenuinesnapshot
    OriginalExpiryTimes List<double>
    List of originalexpirytime
    ReplicationJournalVolume bool
    Value for replicationjournalvolume
    ReplicationTimeStamps List<double>
    List of replicationtimestamp
    SecureSnapshotExpTimes List<double>
    List of securesnapshotexp_time
    SizeInKbs List<double>
    List of sizeinkb
    StoragePoolIds List<string>
    List of storagepoolid
    TimeStampIsAccurate bool
    Value for timestampis_accurate
    UseRmCache bool
    Value for usermcache
    VolumeReplicationStates List<string>
    List of volumereplicationstate
    VolumeTypes List<string>
    List of volume_type
    VtreeIds List<string>
    List of vtree_id
    AccessModeLimits []string
    List of accessmodelimit
    AncestorVolumeIds []string
    List of ancestorvolumeid
    CompressionMethods []string
    List of compression_method
    ConsistencyGroupIds []string
    List of consistencygroupid
    CreationTimes []float64
    List of creation_time
    DataLayouts []string
    List of data_layout
    Ids []string
    List of id
    LockedAutoSnapshot bool
    Value for lockedautosnapshot
    LockedAutoSnapshotMarkedForRemoval bool
    Value for lockedautosnapshotmarkedfor_removal
    ManagedBies []string
    List of managed_by
    Names []string
    List of name
    NotGenuineSnapshot bool
    Value for notgenuinesnapshot
    OriginalExpiryTimes []float64
    List of originalexpirytime
    ReplicationJournalVolume bool
    Value for replicationjournalvolume
    ReplicationTimeStamps []float64
    List of replicationtimestamp
    SecureSnapshotExpTimes []float64
    List of securesnapshotexp_time
    SizeInKbs []float64
    List of sizeinkb
    StoragePoolIds []string
    List of storagepoolid
    TimeStampIsAccurate bool
    Value for timestampis_accurate
    UseRmCache bool
    Value for usermcache
    VolumeReplicationStates []string
    List of volumereplicationstate
    VolumeTypes []string
    List of volume_type
    VtreeIds []string
    List of vtree_id
    accessModeLimits List<String>
    List of accessmodelimit
    ancestorVolumeIds List<String>
    List of ancestorvolumeid
    compressionMethods List<String>
    List of compression_method
    consistencyGroupIds List<String>
    List of consistencygroupid
    creationTimes List<Double>
    List of creation_time
    dataLayouts List<String>
    List of data_layout
    ids List<String>
    List of id
    lockedAutoSnapshot Boolean
    Value for lockedautosnapshot
    lockedAutoSnapshotMarkedForRemoval Boolean
    Value for lockedautosnapshotmarkedfor_removal
    managedBies List<String>
    List of managed_by
    names List<String>
    List of name
    notGenuineSnapshot Boolean
    Value for notgenuinesnapshot
    originalExpiryTimes List<Double>
    List of originalexpirytime
    replicationJournalVolume Boolean
    Value for replicationjournalvolume
    replicationTimeStamps List<Double>
    List of replicationtimestamp
    secureSnapshotExpTimes List<Double>
    List of securesnapshotexp_time
    sizeInKbs List<Double>
    List of sizeinkb
    storagePoolIds List<String>
    List of storagepoolid
    timeStampIsAccurate Boolean
    Value for timestampis_accurate
    useRmCache Boolean
    Value for usermcache
    volumeReplicationStates List<String>
    List of volumereplicationstate
    volumeTypes List<String>
    List of volume_type
    vtreeIds List<String>
    List of vtree_id
    accessModeLimits string[]
    List of accessmodelimit
    ancestorVolumeIds string[]
    List of ancestorvolumeid
    compressionMethods string[]
    List of compression_method
    consistencyGroupIds string[]
    List of consistencygroupid
    creationTimes number[]
    List of creation_time
    dataLayouts string[]
    List of data_layout
    ids string[]
    List of id
    lockedAutoSnapshot boolean
    Value for lockedautosnapshot
    lockedAutoSnapshotMarkedForRemoval boolean
    Value for lockedautosnapshotmarkedfor_removal
    managedBies string[]
    List of managed_by
    names string[]
    List of name
    notGenuineSnapshot boolean
    Value for notgenuinesnapshot
    originalExpiryTimes number[]
    List of originalexpirytime
    replicationJournalVolume boolean
    Value for replicationjournalvolume
    replicationTimeStamps number[]
    List of replicationtimestamp
    secureSnapshotExpTimes number[]
    List of securesnapshotexp_time
    sizeInKbs number[]
    List of sizeinkb
    storagePoolIds string[]
    List of storagepoolid
    timeStampIsAccurate boolean
    Value for timestampis_accurate
    useRmCache boolean
    Value for usermcache
    volumeReplicationStates string[]
    List of volumereplicationstate
    volumeTypes string[]
    List of volume_type
    vtreeIds string[]
    List of vtree_id
    access_mode_limits Sequence[str]
    List of accessmodelimit
    ancestor_volume_ids Sequence[str]
    List of ancestorvolumeid
    compression_methods Sequence[str]
    List of compression_method
    consistency_group_ids Sequence[str]
    List of consistencygroupid
    creation_times Sequence[float]
    List of creation_time
    data_layouts Sequence[str]
    List of data_layout
    ids Sequence[str]
    List of id
    locked_auto_snapshot bool
    Value for lockedautosnapshot
    locked_auto_snapshot_marked_for_removal bool
    Value for lockedautosnapshotmarkedfor_removal
    managed_bies Sequence[str]
    List of managed_by
    names Sequence[str]
    List of name
    not_genuine_snapshot bool
    Value for notgenuinesnapshot
    original_expiry_times Sequence[float]
    List of originalexpirytime
    replication_journal_volume bool
    Value for replicationjournalvolume
    replication_time_stamps Sequence[float]
    List of replicationtimestamp
    secure_snapshot_exp_times Sequence[float]
    List of securesnapshotexp_time
    size_in_kbs Sequence[float]
    List of sizeinkb
    storage_pool_ids Sequence[str]
    List of storagepoolid
    time_stamp_is_accurate bool
    Value for timestampis_accurate
    use_rm_cache bool
    Value for usermcache
    volume_replication_states Sequence[str]
    List of volumereplicationstate
    volume_types Sequence[str]
    List of volume_type
    vtree_ids Sequence[str]
    List of vtree_id
    accessModeLimits List<String>
    List of accessmodelimit
    ancestorVolumeIds List<String>
    List of ancestorvolumeid
    compressionMethods List<String>
    List of compression_method
    consistencyGroupIds List<String>
    List of consistencygroupid
    creationTimes List<Number>
    List of creation_time
    dataLayouts List<String>
    List of data_layout
    ids List<String>
    List of id
    lockedAutoSnapshot Boolean
    Value for lockedautosnapshot
    lockedAutoSnapshotMarkedForRemoval Boolean
    Value for lockedautosnapshotmarkedfor_removal
    managedBies List<String>
    List of managed_by
    names List<String>
    List of name
    notGenuineSnapshot Boolean
    Value for notgenuinesnapshot
    originalExpiryTimes List<Number>
    List of originalexpirytime
    replicationJournalVolume Boolean
    Value for replicationjournalvolume
    replicationTimeStamps List<Number>
    List of replicationtimestamp
    secureSnapshotExpTimes List<Number>
    List of securesnapshotexp_time
    sizeInKbs List<Number>
    List of sizeinkb
    storagePoolIds List<String>
    List of storagepoolid
    timeStampIsAccurate Boolean
    Value for timestampis_accurate
    useRmCache Boolean
    Value for usermcache
    volumeReplicationStates List<String>
    List of volumereplicationstate
    volumeTypes List<String>
    List of volume_type
    vtreeIds List<String>
    List of vtree_id

    GetVolumeVolume

    AccessModeLimit string
    Specifies the access mode limit.
    AncestorVolumeId string
    The volume id to which the snapshot is linked to.
    CompressionMethod string
    Specifies the compression method.
    ConsistencyGroupId string
    The unique id for the consistency group.
    CreationTime double
    Specifies the time of creation.
    DataLayout string
    Specifies the layout for the data.
    Id string
    Unique identifier of the volume instance.
    Links List<GetVolumeVolumeLink>
    Specifies the links associated for a volume.
    LockedAutoSnapshot bool
    Specifies if it's a locked auto snapshot.
    LockedAutoSnapshotMarkedForRemoval bool
    Specifies if it's a locked auto snapshot marked for removal.
    ManagedBy string
    Specifies by whom it's managed by.
    MappedSdcInfos List<GetVolumeVolumeMappedSdcInfo>
    Specifies the list of sdc's mapped to a volume.
    Name string
    Name of the volume.
    NotGenuineSnapshot bool
    Specifies if not genuine snapshot.
    OriginalExpiryTime double
    Specifies the original expiry time.
    ReplicationJournalVolume bool
    Specifies the replication journal volume.
    ReplicationTimeStamp double
    Specifies the replication time stamp.
    SecureSnapshotExpTime double
    Specifies the secure snapshot expiry time.
    SizeInKb double
    Size of the volume in KB
    StoragePoolId string
    Specifies the unique identifier of the storage pool.
    TimeStampIsAccurate bool
    Specifies if the time stamp is accurate.
    UseRmCache bool
    Enable rm cache.
    VolumeReplicationState string
    Specifies the volume replication state.
    VolumeType string
    Specifies the type of that volume.
    VtreeId string
    Unique identifier of the VTree
    AccessModeLimit string
    Specifies the access mode limit.
    AncestorVolumeId string
    The volume id to which the snapshot is linked to.
    CompressionMethod string
    Specifies the compression method.
    ConsistencyGroupId string
    The unique id for the consistency group.
    CreationTime float64
    Specifies the time of creation.
    DataLayout string
    Specifies the layout for the data.
    Id string
    Unique identifier of the volume instance.
    Links []GetVolumeVolumeLink
    Specifies the links associated for a volume.
    LockedAutoSnapshot bool
    Specifies if it's a locked auto snapshot.
    LockedAutoSnapshotMarkedForRemoval bool
    Specifies if it's a locked auto snapshot marked for removal.
    ManagedBy string
    Specifies by whom it's managed by.
    MappedSdcInfos []GetVolumeVolumeMappedSdcInfo
    Specifies the list of sdc's mapped to a volume.
    Name string
    Name of the volume.
    NotGenuineSnapshot bool
    Specifies if not genuine snapshot.
    OriginalExpiryTime float64
    Specifies the original expiry time.
    ReplicationJournalVolume bool
    Specifies the replication journal volume.
    ReplicationTimeStamp float64
    Specifies the replication time stamp.
    SecureSnapshotExpTime float64
    Specifies the secure snapshot expiry time.
    SizeInKb float64
    Size of the volume in KB
    StoragePoolId string
    Specifies the unique identifier of the storage pool.
    TimeStampIsAccurate bool
    Specifies if the time stamp is accurate.
    UseRmCache bool
    Enable rm cache.
    VolumeReplicationState string
    Specifies the volume replication state.
    VolumeType string
    Specifies the type of that volume.
    VtreeId string
    Unique identifier of the VTree
    accessModeLimit String
    Specifies the access mode limit.
    ancestorVolumeId String
    The volume id to which the snapshot is linked to.
    compressionMethod String
    Specifies the compression method.
    consistencyGroupId String
    The unique id for the consistency group.
    creationTime Double
    Specifies the time of creation.
    dataLayout String
    Specifies the layout for the data.
    id String
    Unique identifier of the volume instance.
    links List<GetVolumeVolumeLink>
    Specifies the links associated for a volume.
    lockedAutoSnapshot Boolean
    Specifies if it's a locked auto snapshot.
    lockedAutoSnapshotMarkedForRemoval Boolean
    Specifies if it's a locked auto snapshot marked for removal.
    managedBy String
    Specifies by whom it's managed by.
    mappedSdcInfos List<GetVolumeVolumeMappedSdcInfo>
    Specifies the list of sdc's mapped to a volume.
    name String
    Name of the volume.
    notGenuineSnapshot Boolean
    Specifies if not genuine snapshot.
    originalExpiryTime Double
    Specifies the original expiry time.
    replicationJournalVolume Boolean
    Specifies the replication journal volume.
    replicationTimeStamp Double
    Specifies the replication time stamp.
    secureSnapshotExpTime Double
    Specifies the secure snapshot expiry time.
    sizeInKb Double
    Size of the volume in KB
    storagePoolId String
    Specifies the unique identifier of the storage pool.
    timeStampIsAccurate Boolean
    Specifies if the time stamp is accurate.
    useRmCache Boolean
    Enable rm cache.
    volumeReplicationState String
    Specifies the volume replication state.
    volumeType String
    Specifies the type of that volume.
    vtreeId String
    Unique identifier of the VTree
    accessModeLimit string
    Specifies the access mode limit.
    ancestorVolumeId string
    The volume id to which the snapshot is linked to.
    compressionMethod string
    Specifies the compression method.
    consistencyGroupId string
    The unique id for the consistency group.
    creationTime number
    Specifies the time of creation.
    dataLayout string
    Specifies the layout for the data.
    id string
    Unique identifier of the volume instance.
    links GetVolumeVolumeLink[]
    Specifies the links associated for a volume.
    lockedAutoSnapshot boolean
    Specifies if it's a locked auto snapshot.
    lockedAutoSnapshotMarkedForRemoval boolean
    Specifies if it's a locked auto snapshot marked for removal.
    managedBy string
    Specifies by whom it's managed by.
    mappedSdcInfos GetVolumeVolumeMappedSdcInfo[]
    Specifies the list of sdc's mapped to a volume.
    name string
    Name of the volume.
    notGenuineSnapshot boolean
    Specifies if not genuine snapshot.
    originalExpiryTime number
    Specifies the original expiry time.
    replicationJournalVolume boolean
    Specifies the replication journal volume.
    replicationTimeStamp number
    Specifies the replication time stamp.
    secureSnapshotExpTime number
    Specifies the secure snapshot expiry time.
    sizeInKb number
    Size of the volume in KB
    storagePoolId string
    Specifies the unique identifier of the storage pool.
    timeStampIsAccurate boolean
    Specifies if the time stamp is accurate.
    useRmCache boolean
    Enable rm cache.
    volumeReplicationState string
    Specifies the volume replication state.
    volumeType string
    Specifies the type of that volume.
    vtreeId string
    Unique identifier of the VTree
    access_mode_limit str
    Specifies the access mode limit.
    ancestor_volume_id str
    The volume id to which the snapshot is linked to.
    compression_method str
    Specifies the compression method.
    consistency_group_id str
    The unique id for the consistency group.
    creation_time float
    Specifies the time of creation.
    data_layout str
    Specifies the layout for the data.
    id str
    Unique identifier of the volume instance.
    links Sequence[GetVolumeVolumeLink]
    Specifies the links associated for a volume.
    locked_auto_snapshot bool
    Specifies if it's a locked auto snapshot.
    locked_auto_snapshot_marked_for_removal bool
    Specifies if it's a locked auto snapshot marked for removal.
    managed_by str
    Specifies by whom it's managed by.
    mapped_sdc_infos Sequence[GetVolumeVolumeMappedSdcInfo]
    Specifies the list of sdc's mapped to a volume.
    name str
    Name of the volume.
    not_genuine_snapshot bool
    Specifies if not genuine snapshot.
    original_expiry_time float
    Specifies the original expiry time.
    replication_journal_volume bool
    Specifies the replication journal volume.
    replication_time_stamp float
    Specifies the replication time stamp.
    secure_snapshot_exp_time float
    Specifies the secure snapshot expiry time.
    size_in_kb float
    Size of the volume in KB
    storage_pool_id str
    Specifies the unique identifier of the storage pool.
    time_stamp_is_accurate bool
    Specifies if the time stamp is accurate.
    use_rm_cache bool
    Enable rm cache.
    volume_replication_state str
    Specifies the volume replication state.
    volume_type str
    Specifies the type of that volume.
    vtree_id str
    Unique identifier of the VTree
    accessModeLimit String
    Specifies the access mode limit.
    ancestorVolumeId String
    The volume id to which the snapshot is linked to.
    compressionMethod String
    Specifies the compression method.
    consistencyGroupId String
    The unique id for the consistency group.
    creationTime Number
    Specifies the time of creation.
    dataLayout String
    Specifies the layout for the data.
    id String
    Unique identifier of the volume instance.
    links List<Property Map>
    Specifies the links associated for a volume.
    lockedAutoSnapshot Boolean
    Specifies if it's a locked auto snapshot.
    lockedAutoSnapshotMarkedForRemoval Boolean
    Specifies if it's a locked auto snapshot marked for removal.
    managedBy String
    Specifies by whom it's managed by.
    mappedSdcInfos List<Property Map>
    Specifies the list of sdc's mapped to a volume.
    name String
    Name of the volume.
    notGenuineSnapshot Boolean
    Specifies if not genuine snapshot.
    originalExpiryTime Number
    Specifies the original expiry time.
    replicationJournalVolume Boolean
    Specifies the replication journal volume.
    replicationTimeStamp Number
    Specifies the replication time stamp.
    secureSnapshotExpTime Number
    Specifies the secure snapshot expiry time.
    sizeInKb Number
    Size of the volume in KB
    storagePoolId String
    Specifies the unique identifier of the storage pool.
    timeStampIsAccurate Boolean
    Specifies if the time stamp is accurate.
    useRmCache Boolean
    Enable rm cache.
    volumeReplicationState String
    Specifies the volume replication state.
    volumeType String
    Specifies the type of that volume.
    vtreeId String
    Unique identifier of the VTree
    Href string
    Specifies the exact path to fetch the details.
    Rel string
    Specifies the relationship with the volume.
    Href string
    Specifies the exact path to fetch the details.
    Rel string
    Specifies the relationship with the volume.
    href String
    Specifies the exact path to fetch the details.
    rel String
    Specifies the relationship with the volume.
    href string
    Specifies the exact path to fetch the details.
    rel string
    Specifies the relationship with the volume.
    href str
    Specifies the exact path to fetch the details.
    rel str
    Specifies the relationship with the volume.
    href String
    Specifies the exact path to fetch the details.
    rel String
    Specifies the relationship with the volume.

    GetVolumeVolumeMappedSdcInfo

    AccessMode string
    Specifies the access mode.
    IsDirectBufferMapping bool
    Specifies if it is direct buffer mapping.
    LimitBwInMbps double
    Specifies the bandwidth limits in Mbps.
    LimitIops double
    Specifies the IOPS limits.
    SdcId string
    Unique identifier for sdc.
    SdcIp string
    Ip of the sdc.
    SdcName string
    Specifies the name of the sdc.
    AccessMode string
    Specifies the access mode.
    IsDirectBufferMapping bool
    Specifies if it is direct buffer mapping.
    LimitBwInMbps float64
    Specifies the bandwidth limits in Mbps.
    LimitIops float64
    Specifies the IOPS limits.
    SdcId string
    Unique identifier for sdc.
    SdcIp string
    Ip of the sdc.
    SdcName string
    Specifies the name of the sdc.
    accessMode String
    Specifies the access mode.
    isDirectBufferMapping Boolean
    Specifies if it is direct buffer mapping.
    limitBwInMbps Double
    Specifies the bandwidth limits in Mbps.
    limitIops Double
    Specifies the IOPS limits.
    sdcId String
    Unique identifier for sdc.
    sdcIp String
    Ip of the sdc.
    sdcName String
    Specifies the name of the sdc.
    accessMode string
    Specifies the access mode.
    isDirectBufferMapping boolean
    Specifies if it is direct buffer mapping.
    limitBwInMbps number
    Specifies the bandwidth limits in Mbps.
    limitIops number
    Specifies the IOPS limits.
    sdcId string
    Unique identifier for sdc.
    sdcIp string
    Ip of the sdc.
    sdcName string
    Specifies the name of the sdc.
    access_mode str
    Specifies the access mode.
    is_direct_buffer_mapping bool
    Specifies if it is direct buffer mapping.
    limit_bw_in_mbps float
    Specifies the bandwidth limits in Mbps.
    limit_iops float
    Specifies the IOPS limits.
    sdc_id str
    Unique identifier for sdc.
    sdc_ip str
    Ip of the sdc.
    sdc_name str
    Specifies the name of the sdc.
    accessMode String
    Specifies the access mode.
    isDirectBufferMapping Boolean
    Specifies if it is direct buffer mapping.
    limitBwInMbps Number
    Specifies the bandwidth limits in Mbps.
    limitIops Number
    Specifies the IOPS limits.
    sdcId String
    Unique identifier for sdc.
    sdcIp String
    Ip of the sdc.
    sdcName String
    Specifies the name of the sdc.

    Package Details

    Repository
    powerflex dell/terraform-provider-powerflex
    License
    Notes
    This Pulumi package is based on the powerflex Terraform Provider.
    powerflex logo
    powerflex 1.8.0 published on Monday, Apr 14, 2025 by dell
    dell/terraform-provider-powerflex
      Meet Neo: Your AI Platform Teammate