Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Powerflex Provider
  3. API Docs
  4. getSnapshotPolicy
powerflex 1.8.0 published on Monday, Apr 14, 2025 by dell
dell/terraform-provider-powerflex

powerflex.getSnapshotPolicy

Explore with Pulumi AI

powerflex 1.8.0 published on Monday, Apr 14, 2025 by dell
dell/terraform-provider-powerflex

Using getSnapshotPolicy

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 getSnapshotPolicy(args: GetSnapshotPolicyArgs, opts?: InvokeOptions): Promise<GetSnapshotPolicyResult>
function getSnapshotPolicyOutput(args: GetSnapshotPolicyOutputArgs, opts?: InvokeOptions): Output<GetSnapshotPolicyResult>
Copy
def get_snapshot_policy(filter: Optional[GetSnapshotPolicyFilter] = None,
                        opts: Optional[InvokeOptions] = None) -> GetSnapshotPolicyResult
def get_snapshot_policy_output(filter: Optional[pulumi.Input[GetSnapshotPolicyFilterArgs]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetSnapshotPolicyResult]
Copy
func LookupSnapshotPolicy(ctx *Context, args *LookupSnapshotPolicyArgs, opts ...InvokeOption) (*LookupSnapshotPolicyResult, error)
func LookupSnapshotPolicyOutput(ctx *Context, args *LookupSnapshotPolicyOutputArgs, opts ...InvokeOption) LookupSnapshotPolicyResultOutput
Copy

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

public static class GetSnapshotPolicy 
{
    public static Task<GetSnapshotPolicyResult> InvokeAsync(GetSnapshotPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetSnapshotPolicyResult> Invoke(GetSnapshotPolicyInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSnapshotPolicyResult> getSnapshotPolicy(GetSnapshotPolicyArgs args, InvokeOptions options)
public static Output<GetSnapshotPolicyResult> getSnapshotPolicy(GetSnapshotPolicyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: powerflex:index/getSnapshotPolicy:getSnapshotPolicy
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

getSnapshotPolicy Result

The following output properties are available:

Id string
Unique identifier of the snapshot policy instance to fetch. Conflicts with name.
Snapshotpolicies List<GetSnapshotPolicySnapshotpolicy>
List of snapshot policies.
Filter GetSnapshotPolicyFilter
Id string
Unique identifier of the snapshot policy instance to fetch. Conflicts with name.
Snapshotpolicies []GetSnapshotPolicySnapshotpolicy
List of snapshot policies.
Filter GetSnapshotPolicyFilter
id String
Unique identifier of the snapshot policy instance to fetch. Conflicts with name.
snapshotpolicies List<GetSnapshotPolicySnapshotpolicy>
List of snapshot policies.
filter GetSnapshotPolicyFilter
id string
Unique identifier of the snapshot policy instance to fetch. Conflicts with name.
snapshotpolicies GetSnapshotPolicySnapshotpolicy[]
List of snapshot policies.
filter GetSnapshotPolicyFilter
id str
Unique identifier of the snapshot policy instance to fetch. Conflicts with name.
snapshotpolicies Sequence[GetSnapshotPolicySnapshotpolicy]
List of snapshot policies.
filter GetSnapshotPolicyFilter
id String
Unique identifier of the snapshot policy instance to fetch. Conflicts with name.
snapshotpolicies List<Property Map>
List of snapshot policies.
filter Property Map

Supporting Types

GetSnapshotPolicyFilter

AutoSnapshotCreationCadenceInMins List<double>
List of autosnapshotcreationcadencein_min
Ids List<string>
List of id
LastAutoSnapshotCreationFailureReasons List<string>
List of lastautosnapshotcreationfailure_reason
LastAutoSnapshotFailureInFirstLevel bool
Value for lastautosnapshotfailureinfirstlevel
MaxVtreeAutoSnapshots List<double>
List of maxvtreeauto_snapshots
Names List<string>
List of name
NextAutoSnapshotCreationTimes List<double>
List of nextautosnapshotcreationtime
NumOfAutoSnapshots List<double>
List of numofauto_snapshots
NumOfCreationFailures List<double>
List of numofcreation_failures
NumOfExpiredButLockedSnapshots List<double>
List of numofexpiredbutlocked_snapshots
NumOfLockedSnapshots List<double>
List of numoflocked_snapshots
NumOfRetainedSnapshotsPerLevels List<double>
List of numofretainedsnapshotsper_level
NumOfSourceVolumes List<double>
List of numofsource_volumes
SecureSnapshots bool
Value for secure_snapshots
SnapshotAccessModes List<string>
List of snapshotaccessmode
SnapshotPolicyStates List<string>
List of snapshotpolicystate
SystemIds List<string>
List of system_id
TimeOfLastAutoSnapshotCreationFailures List<double>
List of timeoflastautosnapshotcreationfailure
TimeOfLastAutoSnapshots List<double>
List of timeoflastautosnapshot
AutoSnapshotCreationCadenceInMins []float64
List of autosnapshotcreationcadencein_min
Ids []string
List of id
LastAutoSnapshotCreationFailureReasons []string
List of lastautosnapshotcreationfailure_reason
LastAutoSnapshotFailureInFirstLevel bool
Value for lastautosnapshotfailureinfirstlevel
MaxVtreeAutoSnapshots []float64
List of maxvtreeauto_snapshots
Names []string
List of name
NextAutoSnapshotCreationTimes []float64
List of nextautosnapshotcreationtime
NumOfAutoSnapshots []float64
List of numofauto_snapshots
NumOfCreationFailures []float64
List of numofcreation_failures
NumOfExpiredButLockedSnapshots []float64
List of numofexpiredbutlocked_snapshots
NumOfLockedSnapshots []float64
List of numoflocked_snapshots
NumOfRetainedSnapshotsPerLevels []float64
List of numofretainedsnapshotsper_level
NumOfSourceVolumes []float64
List of numofsource_volumes
SecureSnapshots bool
Value for secure_snapshots
SnapshotAccessModes []string
List of snapshotaccessmode
SnapshotPolicyStates []string
List of snapshotpolicystate
SystemIds []string
List of system_id
TimeOfLastAutoSnapshotCreationFailures []float64
List of timeoflastautosnapshotcreationfailure
TimeOfLastAutoSnapshots []float64
List of timeoflastautosnapshot
autoSnapshotCreationCadenceInMins List<Double>
List of autosnapshotcreationcadencein_min
ids List<String>
List of id
lastAutoSnapshotCreationFailureReasons List<String>
List of lastautosnapshotcreationfailure_reason
lastAutoSnapshotFailureInFirstLevel Boolean
Value for lastautosnapshotfailureinfirstlevel
maxVtreeAutoSnapshots List<Double>
List of maxvtreeauto_snapshots
names List<String>
List of name
nextAutoSnapshotCreationTimes List<Double>
List of nextautosnapshotcreationtime
numOfAutoSnapshots List<Double>
List of numofauto_snapshots
numOfCreationFailures List<Double>
List of numofcreation_failures
numOfExpiredButLockedSnapshots List<Double>
List of numofexpiredbutlocked_snapshots
numOfLockedSnapshots List<Double>
List of numoflocked_snapshots
numOfRetainedSnapshotsPerLevels List<Double>
List of numofretainedsnapshotsper_level
numOfSourceVolumes List<Double>
List of numofsource_volumes
secureSnapshots Boolean
Value for secure_snapshots
snapshotAccessModes List<String>
List of snapshotaccessmode
snapshotPolicyStates List<String>
List of snapshotpolicystate
systemIds List<String>
List of system_id
timeOfLastAutoSnapshotCreationFailures List<Double>
List of timeoflastautosnapshotcreationfailure
timeOfLastAutoSnapshots List<Double>
List of timeoflastautosnapshot
autoSnapshotCreationCadenceInMins number[]
List of autosnapshotcreationcadencein_min
ids string[]
List of id
lastAutoSnapshotCreationFailureReasons string[]
List of lastautosnapshotcreationfailure_reason
lastAutoSnapshotFailureInFirstLevel boolean
Value for lastautosnapshotfailureinfirstlevel
maxVtreeAutoSnapshots number[]
List of maxvtreeauto_snapshots
names string[]
List of name
nextAutoSnapshotCreationTimes number[]
List of nextautosnapshotcreationtime
numOfAutoSnapshots number[]
List of numofauto_snapshots
numOfCreationFailures number[]
List of numofcreation_failures
numOfExpiredButLockedSnapshots number[]
List of numofexpiredbutlocked_snapshots
numOfLockedSnapshots number[]
List of numoflocked_snapshots
numOfRetainedSnapshotsPerLevels number[]
List of numofretainedsnapshotsper_level
numOfSourceVolumes number[]
List of numofsource_volumes
secureSnapshots boolean
Value for secure_snapshots
snapshotAccessModes string[]
List of snapshotaccessmode
snapshotPolicyStates string[]
List of snapshotpolicystate
systemIds string[]
List of system_id
timeOfLastAutoSnapshotCreationFailures number[]
List of timeoflastautosnapshotcreationfailure
timeOfLastAutoSnapshots number[]
List of timeoflastautosnapshot
auto_snapshot_creation_cadence_in_mins Sequence[float]
List of autosnapshotcreationcadencein_min
ids Sequence[str]
List of id
last_auto_snapshot_creation_failure_reasons Sequence[str]
List of lastautosnapshotcreationfailure_reason
last_auto_snapshot_failure_in_first_level bool
Value for lastautosnapshotfailureinfirstlevel
max_vtree_auto_snapshots Sequence[float]
List of maxvtreeauto_snapshots
names Sequence[str]
List of name
next_auto_snapshot_creation_times Sequence[float]
List of nextautosnapshotcreationtime
num_of_auto_snapshots Sequence[float]
List of numofauto_snapshots
num_of_creation_failures Sequence[float]
List of numofcreation_failures
num_of_expired_but_locked_snapshots Sequence[float]
List of numofexpiredbutlocked_snapshots
num_of_locked_snapshots Sequence[float]
List of numoflocked_snapshots
num_of_retained_snapshots_per_levels Sequence[float]
List of numofretainedsnapshotsper_level
num_of_source_volumes Sequence[float]
List of numofsource_volumes
secure_snapshots bool
Value for secure_snapshots
snapshot_access_modes Sequence[str]
List of snapshotaccessmode
snapshot_policy_states Sequence[str]
List of snapshotpolicystate
system_ids Sequence[str]
List of system_id
time_of_last_auto_snapshot_creation_failures Sequence[float]
List of timeoflastautosnapshotcreationfailure
time_of_last_auto_snapshots Sequence[float]
List of timeoflastautosnapshot
autoSnapshotCreationCadenceInMins List<Number>
List of autosnapshotcreationcadencein_min
ids List<String>
List of id
lastAutoSnapshotCreationFailureReasons List<String>
List of lastautosnapshotcreationfailure_reason
lastAutoSnapshotFailureInFirstLevel Boolean
Value for lastautosnapshotfailureinfirstlevel
maxVtreeAutoSnapshots List<Number>
List of maxvtreeauto_snapshots
names List<String>
List of name
nextAutoSnapshotCreationTimes List<Number>
List of nextautosnapshotcreationtime
numOfAutoSnapshots List<Number>
List of numofauto_snapshots
numOfCreationFailures List<Number>
List of numofcreation_failures
numOfExpiredButLockedSnapshots List<Number>
List of numofexpiredbutlocked_snapshots
numOfLockedSnapshots List<Number>
List of numoflocked_snapshots
numOfRetainedSnapshotsPerLevels List<Number>
List of numofretainedsnapshotsper_level
numOfSourceVolumes List<Number>
List of numofsource_volumes
secureSnapshots Boolean
Value for secure_snapshots
snapshotAccessModes List<String>
List of snapshotaccessmode
snapshotPolicyStates List<String>
List of snapshotpolicystate
systemIds List<String>
List of system_id
timeOfLastAutoSnapshotCreationFailures List<Number>
List of timeoflastautosnapshotcreationfailure
timeOfLastAutoSnapshots List<Number>
List of timeoflastautosnapshot

GetSnapshotPolicySnapshotpolicy

AutoSnapshotCreationCadenceInMin This property is required. double
Auto snapshot creation cadence in min.
Id This property is required. string
Unique identifier of the snapshot policy instance.
LastAutoSnapshotCreationFailureReason This property is required. string
Last auto snapshot creation failure reason.
LastAutoSnapshotFailureInFirstLevel This property is required. bool
Last auto snapshot failure in first level.
Links This property is required. List<GetSnapshotPolicySnapshotpolicyLink>
Specifies the links associated for a snapshot policy.
MaxVtreeAutoSnapshots This property is required. double
Max vtree auto snapshots.
Name This property is required. string
Name of the snapshot policy.
NextAutoSnapshotCreationTime This property is required. double
Next auto snapshot creation time.
NumOfAutoSnapshots This property is required. double
Number of auto snapshots.
NumOfCreationFailures This property is required. double
Number of creation failures.
NumOfExpiredButLockedSnapshots This property is required. double
Number of expired but locked snapshots.
NumOfLockedSnapshots This property is required. double
Number of locked snapshots.
NumOfRetainedSnapshotsPerLevels This property is required. List<double>
Number of retained snapshots per level.
NumOfSourceVolumes This property is required. double
Number of source Volumes.
SecureSnapshots This property is required. bool
Secure snapshots.
SnapshotAccessMode This property is required. string
Snapshot Access Mode.
SnapshotPolicyState This property is required. string
Specifies the current state of the snapshot policy.
SystemId This property is required. string
System Identifier.
TimeOfLastAutoSnapshot This property is required. double
Time of last auto snapshot.
TimeOfLastAutoSnapshotCreationFailure This property is required. double
Time of last auto snapshot creation failure.
AutoSnapshotCreationCadenceInMin This property is required. float64
Auto snapshot creation cadence in min.
Id This property is required. string
Unique identifier of the snapshot policy instance.
LastAutoSnapshotCreationFailureReason This property is required. string
Last auto snapshot creation failure reason.
LastAutoSnapshotFailureInFirstLevel This property is required. bool
Last auto snapshot failure in first level.
Links This property is required. []GetSnapshotPolicySnapshotpolicyLink
Specifies the links associated for a snapshot policy.
MaxVtreeAutoSnapshots This property is required. float64
Max vtree auto snapshots.
Name This property is required. string
Name of the snapshot policy.
NextAutoSnapshotCreationTime This property is required. float64
Next auto snapshot creation time.
NumOfAutoSnapshots This property is required. float64
Number of auto snapshots.
NumOfCreationFailures This property is required. float64
Number of creation failures.
NumOfExpiredButLockedSnapshots This property is required. float64
Number of expired but locked snapshots.
NumOfLockedSnapshots This property is required. float64
Number of locked snapshots.
NumOfRetainedSnapshotsPerLevels This property is required. []float64
Number of retained snapshots per level.
NumOfSourceVolumes This property is required. float64
Number of source Volumes.
SecureSnapshots This property is required. bool
Secure snapshots.
SnapshotAccessMode This property is required. string
Snapshot Access Mode.
SnapshotPolicyState This property is required. string
Specifies the current state of the snapshot policy.
SystemId This property is required. string
System Identifier.
TimeOfLastAutoSnapshot This property is required. float64
Time of last auto snapshot.
TimeOfLastAutoSnapshotCreationFailure This property is required. float64
Time of last auto snapshot creation failure.
autoSnapshotCreationCadenceInMin This property is required. Double
Auto snapshot creation cadence in min.
id This property is required. String
Unique identifier of the snapshot policy instance.
lastAutoSnapshotCreationFailureReason This property is required. String
Last auto snapshot creation failure reason.
lastAutoSnapshotFailureInFirstLevel This property is required. Boolean
Last auto snapshot failure in first level.
links This property is required. List<GetSnapshotPolicySnapshotpolicyLink>
Specifies the links associated for a snapshot policy.
maxVtreeAutoSnapshots This property is required. Double
Max vtree auto snapshots.
name This property is required. String
Name of the snapshot policy.
nextAutoSnapshotCreationTime This property is required. Double
Next auto snapshot creation time.
numOfAutoSnapshots This property is required. Double
Number of auto snapshots.
numOfCreationFailures This property is required. Double
Number of creation failures.
numOfExpiredButLockedSnapshots This property is required. Double
Number of expired but locked snapshots.
numOfLockedSnapshots This property is required. Double
Number of locked snapshots.
numOfRetainedSnapshotsPerLevels This property is required. List<Double>
Number of retained snapshots per level.
numOfSourceVolumes This property is required. Double
Number of source Volumes.
secureSnapshots This property is required. Boolean
Secure snapshots.
snapshotAccessMode This property is required. String
Snapshot Access Mode.
snapshotPolicyState This property is required. String
Specifies the current state of the snapshot policy.
systemId This property is required. String
System Identifier.
timeOfLastAutoSnapshot This property is required. Double
Time of last auto snapshot.
timeOfLastAutoSnapshotCreationFailure This property is required. Double
Time of last auto snapshot creation failure.
autoSnapshotCreationCadenceInMin This property is required. number
Auto snapshot creation cadence in min.
id This property is required. string
Unique identifier of the snapshot policy instance.
lastAutoSnapshotCreationFailureReason This property is required. string
Last auto snapshot creation failure reason.
lastAutoSnapshotFailureInFirstLevel This property is required. boolean
Last auto snapshot failure in first level.
links This property is required. GetSnapshotPolicySnapshotpolicyLink[]
Specifies the links associated for a snapshot policy.
maxVtreeAutoSnapshots This property is required. number
Max vtree auto snapshots.
name This property is required. string
Name of the snapshot policy.
nextAutoSnapshotCreationTime This property is required. number
Next auto snapshot creation time.
numOfAutoSnapshots This property is required. number
Number of auto snapshots.
numOfCreationFailures This property is required. number
Number of creation failures.
numOfExpiredButLockedSnapshots This property is required. number
Number of expired but locked snapshots.
numOfLockedSnapshots This property is required. number
Number of locked snapshots.
numOfRetainedSnapshotsPerLevels This property is required. number[]
Number of retained snapshots per level.
numOfSourceVolumes This property is required. number
Number of source Volumes.
secureSnapshots This property is required. boolean
Secure snapshots.
snapshotAccessMode This property is required. string
Snapshot Access Mode.
snapshotPolicyState This property is required. string
Specifies the current state of the snapshot policy.
systemId This property is required. string
System Identifier.
timeOfLastAutoSnapshot This property is required. number
Time of last auto snapshot.
timeOfLastAutoSnapshotCreationFailure This property is required. number
Time of last auto snapshot creation failure.
auto_snapshot_creation_cadence_in_min This property is required. float
Auto snapshot creation cadence in min.
id This property is required. str
Unique identifier of the snapshot policy instance.
last_auto_snapshot_creation_failure_reason This property is required. str
Last auto snapshot creation failure reason.
last_auto_snapshot_failure_in_first_level This property is required. bool
Last auto snapshot failure in first level.
links This property is required. Sequence[GetSnapshotPolicySnapshotpolicyLink]
Specifies the links associated for a snapshot policy.
max_vtree_auto_snapshots This property is required. float
Max vtree auto snapshots.
name This property is required. str
Name of the snapshot policy.
next_auto_snapshot_creation_time This property is required. float
Next auto snapshot creation time.
num_of_auto_snapshots This property is required. float
Number of auto snapshots.
num_of_creation_failures This property is required. float
Number of creation failures.
num_of_expired_but_locked_snapshots This property is required. float
Number of expired but locked snapshots.
num_of_locked_snapshots This property is required. float
Number of locked snapshots.
num_of_retained_snapshots_per_levels This property is required. Sequence[float]
Number of retained snapshots per level.
num_of_source_volumes This property is required. float
Number of source Volumes.
secure_snapshots This property is required. bool
Secure snapshots.
snapshot_access_mode This property is required. str
Snapshot Access Mode.
snapshot_policy_state This property is required. str
Specifies the current state of the snapshot policy.
system_id This property is required. str
System Identifier.
time_of_last_auto_snapshot This property is required. float
Time of last auto snapshot.
time_of_last_auto_snapshot_creation_failure This property is required. float
Time of last auto snapshot creation failure.
autoSnapshotCreationCadenceInMin This property is required. Number
Auto snapshot creation cadence in min.
id This property is required. String
Unique identifier of the snapshot policy instance.
lastAutoSnapshotCreationFailureReason This property is required. String
Last auto snapshot creation failure reason.
lastAutoSnapshotFailureInFirstLevel This property is required. Boolean
Last auto snapshot failure in first level.
links This property is required. List<Property Map>
Specifies the links associated for a snapshot policy.
maxVtreeAutoSnapshots This property is required. Number
Max vtree auto snapshots.
name This property is required. String
Name of the snapshot policy.
nextAutoSnapshotCreationTime This property is required. Number
Next auto snapshot creation time.
numOfAutoSnapshots This property is required. Number
Number of auto snapshots.
numOfCreationFailures This property is required. Number
Number of creation failures.
numOfExpiredButLockedSnapshots This property is required. Number
Number of expired but locked snapshots.
numOfLockedSnapshots This property is required. Number
Number of locked snapshots.
numOfRetainedSnapshotsPerLevels This property is required. List<Number>
Number of retained snapshots per level.
numOfSourceVolumes This property is required. Number
Number of source Volumes.
secureSnapshots This property is required. Boolean
Secure snapshots.
snapshotAccessMode This property is required. String
Snapshot Access Mode.
snapshotPolicyState This property is required. String
Specifies the current state of the snapshot policy.
systemId This property is required. String
System Identifier.
timeOfLastAutoSnapshot This property is required. Number
Time of last auto snapshot.
timeOfLastAutoSnapshotCreationFailure This property is required. Number
Time of last auto snapshot creation failure.
Href This property is required. string
Specifies the exact path to fetch the details.
Rel This property is required. string
Specifies the relationship with the snapshot policy.
Href This property is required. string
Specifies the exact path to fetch the details.
Rel This property is required. string
Specifies the relationship with the snapshot policy.
href This property is required. String
Specifies the exact path to fetch the details.
rel This property is required. String
Specifies the relationship with the snapshot policy.
href This property is required. string
Specifies the exact path to fetch the details.
rel This property is required. string
Specifies the relationship with the snapshot policy.
href This property is required. str
Specifies the exact path to fetch the details.
rel This property is required. str
Specifies the relationship with the snapshot policy.
href This property is required. String
Specifies the exact path to fetch the details.
rel This property is required. String
Specifies the relationship with the snapshot policy.

Package Details

Repository
powerflex dell/terraform-provider-powerflex
License
Notes
This Pulumi package is based on the powerflex Terraform Provider.
powerflex 1.8.0 published on Monday, Apr 14, 2025 by dell
dell/terraform-provider-powerflex