Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Powerscale Provider
  3. API Docs
  4. getSnapshot
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
dell/terraform-provider-powerscale

powerscale.getSnapshot

Explore with Pulumi AI

powerscale logo
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
dell/terraform-provider-powerscale

    This datasource is used to query the existing Snapshots from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale Snapshots is a logical pointer to data that is stored on a cluster at a specific point in time.

    Using getSnapshot

    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 getSnapshot(args: GetSnapshotArgs, opts?: InvokeOptions): Promise<GetSnapshotResult>
function getSnapshotOutput(args: GetSnapshotOutputArgs, opts?: InvokeOptions): Output<GetSnapshotResult>
    def get_snapshot(filter: Optional[GetSnapshotFilter] = None,
                 opts: Optional[InvokeOptions] = None) -> GetSnapshotResult
def get_snapshot_output(filter: Optional[pulumi.Input[GetSnapshotFilterArgs]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetSnapshotResult]
    func LookupSnapshot(ctx *Context, args *LookupSnapshotArgs, opts ...InvokeOption) (*LookupSnapshotResult, error)
func LookupSnapshotOutput(ctx *Context, args *LookupSnapshotOutputArgs, opts ...InvokeOption) LookupSnapshotResultOutput

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

    public static class GetSnapshot 
{
    public static Task<GetSnapshotResult> InvokeAsync(GetSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetSnapshotResult> Invoke(GetSnapshotInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
public static Output<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)

    fn::invoke:
  function: powerscale:index/getSnapshot:getSnapshot
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getSnapshot Result

    The following output properties are available:

    id String
    Identifier
    snapshotsDetails List<Property Map>
    List of Snapshots
    filter Property Map

    Supporting Types

    GetSnapshotFilter

    Dir string
    The direction of the sort.
    Limit double
    Return no more than this many results at once (see resume).
    Name string
    Path string
    Schedule string
    The schedule of the snapshot.
    Sort string
    The field that will be used for sorting.
    State string
    The state of the snapshot.
    Type string
    The type of the snapshot.
    Dir string
    The direction of the sort.
    Limit float64
    Return no more than this many results at once (see resume).
    Name string
    Path string
    Schedule string
    The schedule of the snapshot.
    Sort string
    The field that will be used for sorting.
    State string
    The state of the snapshot.
    Type string
    The type of the snapshot.
    dir String
    The direction of the sort.
    limit Double
    Return no more than this many results at once (see resume).
    name String
    path String
    schedule String
    The schedule of the snapshot.
    sort String
    The field that will be used for sorting.
    state String
    The state of the snapshot.
    type String
    The type of the snapshot.
    dir string
    The direction of the sort.
    limit number
    Return no more than this many results at once (see resume).
    name string
    path string
    schedule string
    The schedule of the snapshot.
    sort string
    The field that will be used for sorting.
    state string
    The state of the snapshot.
    type string
    The type of the snapshot.
    dir str
    The direction of the sort.
    limit float
    Return no more than this many results at once (see resume).
    name str
    path str
    schedule str
    The schedule of the snapshot.
    sort str
    The field that will be used for sorting.
    state str
    The state of the snapshot.
    type str
    The type of the snapshot.
    dir String
    The direction of the sort.
    limit Number
    Return no more than this many results at once (see resume).
    name String
    path String
    schedule String
    The schedule of the snapshot.
    sort String
    The field that will be used for sorting.
    state String
    The state of the snapshot.
    type String
    The type of the snapshot.

    GetSnapshotSnapshotsDetail

    Alias string
    The name of the alias, none for real snapshots.
    Created double
    The Unix Epoch time the snapshot was created.
    Expires double
    The Unix Epoch time the snapshot will expire and be eligible for automatic deletion.
    HasLocks bool
    True if the snapshot has one or more locks present see, see the locks subresource of a snapshot for a list of lock.
    Id string
    The system ID given to the snapshot. This is useful for tracking the status of delete pending snapshots.
    Name string
    The user or system supplied snapshot name. This will be null for snapshots pending delete.
    Path string
    The /ifs path snapshotted.
    PctFilesystem double
    Percentage of /ifs used for storing this snapshot.
    PctReserve double
    Percentage of configured snapshot reserved used for storing this snapshot.
    Schedule string
    The name of the schedule used to create this snapshot, if applicable.
    SetExpires string
    The amount of time from creation before the snapshot will expire and be eligible for automatic deletion.
    ShadowBytes double
    The amount of shadow bytes referred to by this snapshot.
    Size double
    The amount of storage in bytes used to store this snapshot.
    State string
    Snapshot state.
    TargetId double
    The ID of the snapshot pointed to if this is an alias. An alias to the live filesystem is represented by the value -1.
    TargetName string
    The name of the snapshot pointed to if this is an alias.
    Alias string
    The name of the alias, none for real snapshots.
    Created float64
    The Unix Epoch time the snapshot was created.
    Expires float64
    The Unix Epoch time the snapshot will expire and be eligible for automatic deletion.
    HasLocks bool
    True if the snapshot has one or more locks present see, see the locks subresource of a snapshot for a list of lock.
    Id string
    The system ID given to the snapshot. This is useful for tracking the status of delete pending snapshots.
    Name string
    The user or system supplied snapshot name. This will be null for snapshots pending delete.
    Path string
    The /ifs path snapshotted.
    PctFilesystem float64
    Percentage of /ifs used for storing this snapshot.
    PctReserve float64
    Percentage of configured snapshot reserved used for storing this snapshot.
    Schedule string
    The name of the schedule used to create this snapshot, if applicable.
    SetExpires string
    The amount of time from creation before the snapshot will expire and be eligible for automatic deletion.
    ShadowBytes float64
    The amount of shadow bytes referred to by this snapshot.
    Size float64
    The amount of storage in bytes used to store this snapshot.
    State string
    Snapshot state.
    TargetId float64
    The ID of the snapshot pointed to if this is an alias. An alias to the live filesystem is represented by the value -1.
    TargetName string
    The name of the snapshot pointed to if this is an alias.
    alias String
    The name of the alias, none for real snapshots.
    created Double
    The Unix Epoch time the snapshot was created.
    expires Double
    The Unix Epoch time the snapshot will expire and be eligible for automatic deletion.
    hasLocks Boolean
    True if the snapshot has one or more locks present see, see the locks subresource of a snapshot for a list of lock.
    id String
    The system ID given to the snapshot. This is useful for tracking the status of delete pending snapshots.
    name String
    The user or system supplied snapshot name. This will be null for snapshots pending delete.
    path String
    The /ifs path snapshotted.
    pctFilesystem Double
    Percentage of /ifs used for storing this snapshot.
    pctReserve Double
    Percentage of configured snapshot reserved used for storing this snapshot.
    schedule String
    The name of the schedule used to create this snapshot, if applicable.
    setExpires String
    The amount of time from creation before the snapshot will expire and be eligible for automatic deletion.
    shadowBytes Double
    The amount of shadow bytes referred to by this snapshot.
    size Double
    The amount of storage in bytes used to store this snapshot.
    state String
    Snapshot state.
    targetId Double
    The ID of the snapshot pointed to if this is an alias. An alias to the live filesystem is represented by the value -1.
    targetName String
    The name of the snapshot pointed to if this is an alias.
    alias string
    The name of the alias, none for real snapshots.
    created number
    The Unix Epoch time the snapshot was created.
    expires number
    The Unix Epoch time the snapshot will expire and be eligible for automatic deletion.
    hasLocks boolean
    True if the snapshot has one or more locks present see, see the locks subresource of a snapshot for a list of lock.
    id string
    The system ID given to the snapshot. This is useful for tracking the status of delete pending snapshots.
    name string
    The user or system supplied snapshot name. This will be null for snapshots pending delete.
    path string
    The /ifs path snapshotted.
    pctFilesystem number
    Percentage of /ifs used for storing this snapshot.
    pctReserve number
    Percentage of configured snapshot reserved used for storing this snapshot.
    schedule string
    The name of the schedule used to create this snapshot, if applicable.
    setExpires string
    The amount of time from creation before the snapshot will expire and be eligible for automatic deletion.
    shadowBytes number
    The amount of shadow bytes referred to by this snapshot.
    size number
    The amount of storage in bytes used to store this snapshot.
    state string
    Snapshot state.
    targetId number
    The ID of the snapshot pointed to if this is an alias. An alias to the live filesystem is represented by the value -1.
    targetName string
    The name of the snapshot pointed to if this is an alias.
    alias str
    The name of the alias, none for real snapshots.
    created float
    The Unix Epoch time the snapshot was created.
    expires float
    The Unix Epoch time the snapshot will expire and be eligible for automatic deletion.
    has_locks bool
    True if the snapshot has one or more locks present see, see the locks subresource of a snapshot for a list of lock.
    id str
    The system ID given to the snapshot. This is useful for tracking the status of delete pending snapshots.
    name str
    The user or system supplied snapshot name. This will be null for snapshots pending delete.
    path str
    The /ifs path snapshotted.
    pct_filesystem float
    Percentage of /ifs used for storing this snapshot.
    pct_reserve float
    Percentage of configured snapshot reserved used for storing this snapshot.
    schedule str
    The name of the schedule used to create this snapshot, if applicable.
    set_expires str
    The amount of time from creation before the snapshot will expire and be eligible for automatic deletion.
    shadow_bytes float
    The amount of shadow bytes referred to by this snapshot.
    size float
    The amount of storage in bytes used to store this snapshot.
    state str
    Snapshot state.
    target_id float
    The ID of the snapshot pointed to if this is an alias. An alias to the live filesystem is represented by the value -1.
    target_name str
    The name of the snapshot pointed to if this is an alias.
    alias String
    The name of the alias, none for real snapshots.
    created Number
    The Unix Epoch time the snapshot was created.
    expires Number
    The Unix Epoch time the snapshot will expire and be eligible for automatic deletion.
    hasLocks Boolean
    True if the snapshot has one or more locks present see, see the locks subresource of a snapshot for a list of lock.
    id String
    The system ID given to the snapshot. This is useful for tracking the status of delete pending snapshots.
    name String
    The user or system supplied snapshot name. This will be null for snapshots pending delete.
    path String
    The /ifs path snapshotted.
    pctFilesystem Number
    Percentage of /ifs used for storing this snapshot.
    pctReserve Number
    Percentage of configured snapshot reserved used for storing this snapshot.
    schedule String
    The name of the schedule used to create this snapshot, if applicable.
    setExpires String
    The amount of time from creation before the snapshot will expire and be eligible for automatic deletion.
    shadowBytes Number
    The amount of shadow bytes referred to by this snapshot.
    size Number
    The amount of storage in bytes used to store this snapshot.
    state String
    Snapshot state.
    targetId Number
    The ID of the snapshot pointed to if this is an alias. An alias to the live filesystem is represented by the value -1.
    targetName String
    The name of the snapshot pointed to if this is an alias.

    Package Details

    Repository
    powerscale dell/terraform-provider-powerscale
    License
    Notes
    This Pulumi package is based on the powerscale Terraform Provider.
    powerscale logo
    powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
    dell/terraform-provider-powerscale