1. Packages
  2. Powerstore Provider
  3. API Docs
  4. getSnapshotrule
powerstore 1.2.0 published on Monday, Apr 14, 2025 by dell

powerstore.getSnapshotrule

Explore with Pulumi AI

powerstore logo
powerstore 1.2.0 published on Monday, Apr 14, 2025 by dell

    Using getSnapshotrule

    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 getSnapshotrule(args: GetSnapshotruleArgs, opts?: InvokeOptions): Promise<GetSnapshotruleResult>
    function getSnapshotruleOutput(args: GetSnapshotruleOutputArgs, opts?: InvokeOptions): Output<GetSnapshotruleResult>
    def get_snapshotrule(id: Optional[str] = None,
                         name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetSnapshotruleResult
    def get_snapshotrule_output(id: Optional[pulumi.Input[str]] = None,
                         name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetSnapshotruleResult]
    func LookupSnapshotrule(ctx *Context, args *LookupSnapshotruleArgs, opts ...InvokeOption) (*LookupSnapshotruleResult, error)
    func LookupSnapshotruleOutput(ctx *Context, args *LookupSnapshotruleOutputArgs, opts ...InvokeOption) LookupSnapshotruleResultOutput

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

    public static class GetSnapshotrule 
    {
        public static Task<GetSnapshotruleResult> InvokeAsync(GetSnapshotruleArgs args, InvokeOptions? opts = null)
        public static Output<GetSnapshotruleResult> Invoke(GetSnapshotruleInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSnapshotruleResult> getSnapshotrule(GetSnapshotruleArgs args, InvokeOptions options)
    public static Output<GetSnapshotruleResult> getSnapshotrule(GetSnapshotruleArgs args, InvokeOptions options)
    
    fn::invoke:
      function: powerstore:index/getSnapshotrule:getSnapshotrule
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Unique identifier of the snapshot rule instance. Conflicts with name.
    Name string
    Name of the snapshot rule. Conflicts with id.
    Id string
    Unique identifier of the snapshot rule instance. Conflicts with name.
    Name string
    Name of the snapshot rule. Conflicts with id.
    id String
    Unique identifier of the snapshot rule instance. Conflicts with name.
    name String
    Name of the snapshot rule. Conflicts with id.
    id string
    Unique identifier of the snapshot rule instance. Conflicts with name.
    name string
    Name of the snapshot rule. Conflicts with id.
    id str
    Unique identifier of the snapshot rule instance. Conflicts with name.
    name str
    Name of the snapshot rule. Conflicts with id.
    id String
    Unique identifier of the snapshot rule instance. Conflicts with name.
    name String
    Name of the snapshot rule. Conflicts with id.

    getSnapshotrule Result

    The following output properties are available:

    Id string
    Unique identifier of the snapshot rule instance. Conflicts with name.
    SnapshotRules List<GetSnapshotruleSnapshotRule>
    List of snapshot rules.
    Name string
    Name of the snapshot rule. Conflicts with id.
    Id string
    Unique identifier of the snapshot rule instance. Conflicts with name.
    SnapshotRules []GetSnapshotruleSnapshotRule
    List of snapshot rules.
    Name string
    Name of the snapshot rule. Conflicts with id.
    id String
    Unique identifier of the snapshot rule instance. Conflicts with name.
    snapshotRules List<GetSnapshotruleSnapshotRule>
    List of snapshot rules.
    name String
    Name of the snapshot rule. Conflicts with id.
    id string
    Unique identifier of the snapshot rule instance. Conflicts with name.
    snapshotRules GetSnapshotruleSnapshotRule[]
    List of snapshot rules.
    name string
    Name of the snapshot rule. Conflicts with id.
    id str
    Unique identifier of the snapshot rule instance. Conflicts with name.
    snapshot_rules Sequence[GetSnapshotruleSnapshotRule]
    List of snapshot rules.
    name str
    Name of the snapshot rule. Conflicts with id.
    id String
    Unique identifier of the snapshot rule instance. Conflicts with name.
    snapshotRules List<Property Map>
    List of snapshot rules.
    name String
    Name of the snapshot rule. Conflicts with id.

    Supporting Types

    GetSnapshotruleSnapshotRule

    DaysOfWeekL10ns List<string>
    Localized message array corresponding to daysofweek
    DaysOfWeeks List<string>
    The days of the week when the snapshot rule should be applied.
    DesiredRetention double
    The Desired snapshot retention period in hours to retain snapshots for this time period.
    Id string
    The ID of the snapshot rule.
    Interval string
    The interval of the snapshot rule.
    IntervalL10n string
    Localized message string corresponding to interval
    IsReadOnly bool
    Indicates whether this snapshot rule can be modified.
    IsReplica bool
    Indicates whether this is a replica of a snapshot rule on a remote system.
    ManagedBy string
    The entity that owns and manages the instance.
    ManagedById string
    The unique id of the managing entity.
    ManagedByL10n string
    Localized message string corresponding to managed_by.
    Name string
    Name of the snapshot rule.
    NasAccessType string
    The NAS filesystem snapshot access method for snapshot rule.
    NasAccessTypeL10n string
    Localized message string corresponding to nasaccesstype.
    Policies List<GetSnapshotruleSnapshotRulePolicy>
    List of the protection policies that are associated with the snapshot*rule..
    TimeOfDay string
    The time of the day to take a daily snapshot, with format hh:mm.
    Timezone string
    The time zone identifier for applying the time zone to the timeofday for a snapshot rule.
    TimezoneL10n string
    Localized message string corresponding to timezone.
    DaysOfWeekL10ns []string
    Localized message array corresponding to daysofweek
    DaysOfWeeks []string
    The days of the week when the snapshot rule should be applied.
    DesiredRetention float64
    The Desired snapshot retention period in hours to retain snapshots for this time period.
    Id string
    The ID of the snapshot rule.
    Interval string
    The interval of the snapshot rule.
    IntervalL10n string
    Localized message string corresponding to interval
    IsReadOnly bool
    Indicates whether this snapshot rule can be modified.
    IsReplica bool
    Indicates whether this is a replica of a snapshot rule on a remote system.
    ManagedBy string
    The entity that owns and manages the instance.
    ManagedById string
    The unique id of the managing entity.
    ManagedByL10n string
    Localized message string corresponding to managed_by.
    Name string
    Name of the snapshot rule.
    NasAccessType string
    The NAS filesystem snapshot access method for snapshot rule.
    NasAccessTypeL10n string
    Localized message string corresponding to nasaccesstype.
    Policies []GetSnapshotruleSnapshotRulePolicy
    List of the protection policies that are associated with the snapshot*rule..
    TimeOfDay string
    The time of the day to take a daily snapshot, with format hh:mm.
    Timezone string
    The time zone identifier for applying the time zone to the timeofday for a snapshot rule.
    TimezoneL10n string
    Localized message string corresponding to timezone.
    daysOfWeekL10ns List<String>
    Localized message array corresponding to daysofweek
    daysOfWeeks List<String>
    The days of the week when the snapshot rule should be applied.
    desiredRetention Double
    The Desired snapshot retention period in hours to retain snapshots for this time period.
    id String
    The ID of the snapshot rule.
    interval String
    The interval of the snapshot rule.
    intervalL10n String
    Localized message string corresponding to interval
    isReadOnly Boolean
    Indicates whether this snapshot rule can be modified.
    isReplica Boolean
    Indicates whether this is a replica of a snapshot rule on a remote system.
    managedBy String
    The entity that owns and manages the instance.
    managedById String
    The unique id of the managing entity.
    managedByL10n String
    Localized message string corresponding to managed_by.
    name String
    Name of the snapshot rule.
    nasAccessType String
    The NAS filesystem snapshot access method for snapshot rule.
    nasAccessTypeL10n String
    Localized message string corresponding to nasaccesstype.
    policies List<GetSnapshotruleSnapshotRulePolicy>
    List of the protection policies that are associated with the snapshot*rule..
    timeOfDay String
    The time of the day to take a daily snapshot, with format hh:mm.
    timezone String
    The time zone identifier for applying the time zone to the timeofday for a snapshot rule.
    timezoneL10n String
    Localized message string corresponding to timezone.
    daysOfWeekL10ns string[]
    Localized message array corresponding to daysofweek
    daysOfWeeks string[]
    The days of the week when the snapshot rule should be applied.
    desiredRetention number
    The Desired snapshot retention period in hours to retain snapshots for this time period.
    id string
    The ID of the snapshot rule.
    interval string
    The interval of the snapshot rule.
    intervalL10n string
    Localized message string corresponding to interval
    isReadOnly boolean
    Indicates whether this snapshot rule can be modified.
    isReplica boolean
    Indicates whether this is a replica of a snapshot rule on a remote system.
    managedBy string
    The entity that owns and manages the instance.
    managedById string
    The unique id of the managing entity.
    managedByL10n string
    Localized message string corresponding to managed_by.
    name string
    Name of the snapshot rule.
    nasAccessType string
    The NAS filesystem snapshot access method for snapshot rule.
    nasAccessTypeL10n string
    Localized message string corresponding to nasaccesstype.
    policies GetSnapshotruleSnapshotRulePolicy[]
    List of the protection policies that are associated with the snapshot*rule..
    timeOfDay string
    The time of the day to take a daily snapshot, with format hh:mm.
    timezone string
    The time zone identifier for applying the time zone to the timeofday for a snapshot rule.
    timezoneL10n string
    Localized message string corresponding to timezone.
    days_of_week_l10ns Sequence[str]
    Localized message array corresponding to daysofweek
    days_of_weeks Sequence[str]
    The days of the week when the snapshot rule should be applied.
    desired_retention float
    The Desired snapshot retention period in hours to retain snapshots for this time period.
    id str
    The ID of the snapshot rule.
    interval str
    The interval of the snapshot rule.
    interval_l10n str
    Localized message string corresponding to interval
    is_read_only bool
    Indicates whether this snapshot rule can be modified.
    is_replica bool
    Indicates whether this is a replica of a snapshot rule on a remote system.
    managed_by str
    The entity that owns and manages the instance.
    managed_by_id str
    The unique id of the managing entity.
    managed_by_l10n str
    Localized message string corresponding to managed_by.
    name str
    Name of the snapshot rule.
    nas_access_type str
    The NAS filesystem snapshot access method for snapshot rule.
    nas_access_type_l10n str
    Localized message string corresponding to nasaccesstype.
    policies Sequence[GetSnapshotruleSnapshotRulePolicy]
    List of the protection policies that are associated with the snapshot*rule..
    time_of_day str
    The time of the day to take a daily snapshot, with format hh:mm.
    timezone str
    The time zone identifier for applying the time zone to the timeofday for a snapshot rule.
    timezone_l10n str
    Localized message string corresponding to timezone.
    daysOfWeekL10ns List<String>
    Localized message array corresponding to daysofweek
    daysOfWeeks List<String>
    The days of the week when the snapshot rule should be applied.
    desiredRetention Number
    The Desired snapshot retention period in hours to retain snapshots for this time period.
    id String
    The ID of the snapshot rule.
    interval String
    The interval of the snapshot rule.
    intervalL10n String
    Localized message string corresponding to interval
    isReadOnly Boolean
    Indicates whether this snapshot rule can be modified.
    isReplica Boolean
    Indicates whether this is a replica of a snapshot rule on a remote system.
    managedBy String
    The entity that owns and manages the instance.
    managedById String
    The unique id of the managing entity.
    managedByL10n String
    Localized message string corresponding to managed_by.
    name String
    Name of the snapshot rule.
    nasAccessType String
    The NAS filesystem snapshot access method for snapshot rule.
    nasAccessTypeL10n String
    Localized message string corresponding to nasaccesstype.
    policies List<Property Map>
    List of the protection policies that are associated with the snapshot*rule..
    timeOfDay String
    The time of the day to take a daily snapshot, with format hh:mm.
    timezone String
    The time zone identifier for applying the time zone to the timeofday for a snapshot rule.
    timezoneL10n String
    Localized message string corresponding to timezone.

    GetSnapshotruleSnapshotRulePolicy

    Description string
    Description of the protection policy.
    Id string
    Unique identifier of the protection policy.
    Name string
    Name of the protection policy.
    Description string
    Description of the protection policy.
    Id string
    Unique identifier of the protection policy.
    Name string
    Name of the protection policy.
    description String
    Description of the protection policy.
    id String
    Unique identifier of the protection policy.
    name String
    Name of the protection policy.
    description string
    Description of the protection policy.
    id string
    Unique identifier of the protection policy.
    name string
    Name of the protection policy.
    description str
    Description of the protection policy.
    id str
    Unique identifier of the protection policy.
    name str
    Name of the protection policy.
    description String
    Description of the protection policy.
    id String
    Unique identifier of the protection policy.
    name String
    Name of the protection policy.

    Package Details

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