1. Packages
  2. Powerscale Provider
  3. API Docs
  4. getSynciqRule
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell

powerscale.getSynciqRule

Explore with Pulumi AI

powerscale logo
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell

    This datasource is used to query the existing SyncIQ Replication Rules from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block.

    Using getSynciqRule

    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 getSynciqRule(args: GetSynciqRuleArgs, opts?: InvokeOptions): Promise<GetSynciqRuleResult>
    function getSynciqRuleOutput(args: GetSynciqRuleOutputArgs, opts?: InvokeOptions): Output<GetSynciqRuleResult>
    def get_synciq_rule(id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetSynciqRuleResult
    def get_synciq_rule_output(id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetSynciqRuleResult]
    func GetSynciqRule(ctx *Context, args *GetSynciqRuleArgs, opts ...InvokeOption) (*GetSynciqRuleResult, error)
    func GetSynciqRuleOutput(ctx *Context, args *GetSynciqRuleOutputArgs, opts ...InvokeOption) GetSynciqRuleResultOutput

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

    public static class GetSynciqRule 
    {
        public static Task<GetSynciqRuleResult> InvokeAsync(GetSynciqRuleArgs args, InvokeOptions? opts = null)
        public static Output<GetSynciqRuleResult> Invoke(GetSynciqRuleInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSynciqRuleResult> getSynciqRule(GetSynciqRuleArgs args, InvokeOptions options)
    public static Output<GetSynciqRuleResult> getSynciqRule(GetSynciqRuleArgs args, InvokeOptions options)
    
    fn::invoke:
      function: powerscale:index/getSynciqRule:getSynciqRule
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Unique identifier of the performance rule.
    Id string
    Unique identifier of the performance rule.
    id String
    Unique identifier of the performance rule.
    id string
    Unique identifier of the performance rule.
    id str
    Unique identifier of the performance rule.
    id String
    Unique identifier of the performance rule.

    getSynciqRule Result

    The following output properties are available:

    Id string
    Unique identifier of the performance rule.
    Rules List<GetSynciqRuleRule>
    Id string
    Unique identifier of the performance rule.
    Rules []GetSynciqRuleRule
    id String
    Unique identifier of the performance rule.
    rules List<GetSynciqRuleRule>
    id string
    Unique identifier of the performance rule.
    rules GetSynciqRuleRule[]
    id str
    Unique identifier of the performance rule.
    rules Sequence[GetSynciqRuleRule]
    id String
    Unique identifier of the performance rule.
    rules List<Property Map>

    Supporting Types

    GetSynciqRuleRule

    Description string
    User-entered description of this performance rule.
    Enabled bool
    Whether this performance rule is currently in effect during its specified intervals.
    Id string
    The system ID given to this performance rule.
    Limit double
    Amount the specified system resource type is limited by this rule. Units are kb/s for bandwidth, files/s for file-count, processing percentage used for cpu, or percentage of maximum available workers.
    Schedule GetSynciqRuleRuleSchedule
    A schedule defining when during a week this performance rule is in effect. If unspecified or null, the schedule will always be in effect.
    Type string
    The type of system resource this rule limits.
    Description string
    User-entered description of this performance rule.
    Enabled bool
    Whether this performance rule is currently in effect during its specified intervals.
    Id string
    The system ID given to this performance rule.
    Limit float64
    Amount the specified system resource type is limited by this rule. Units are kb/s for bandwidth, files/s for file-count, processing percentage used for cpu, or percentage of maximum available workers.
    Schedule GetSynciqRuleRuleSchedule
    A schedule defining when during a week this performance rule is in effect. If unspecified or null, the schedule will always be in effect.
    Type string
    The type of system resource this rule limits.
    description String
    User-entered description of this performance rule.
    enabled Boolean
    Whether this performance rule is currently in effect during its specified intervals.
    id String
    The system ID given to this performance rule.
    limit Double
    Amount the specified system resource type is limited by this rule. Units are kb/s for bandwidth, files/s for file-count, processing percentage used for cpu, or percentage of maximum available workers.
    schedule GetSynciqRuleRuleSchedule
    A schedule defining when during a week this performance rule is in effect. If unspecified or null, the schedule will always be in effect.
    type String
    The type of system resource this rule limits.
    description string
    User-entered description of this performance rule.
    enabled boolean
    Whether this performance rule is currently in effect during its specified intervals.
    id string
    The system ID given to this performance rule.
    limit number
    Amount the specified system resource type is limited by this rule. Units are kb/s for bandwidth, files/s for file-count, processing percentage used for cpu, or percentage of maximum available workers.
    schedule GetSynciqRuleRuleSchedule
    A schedule defining when during a week this performance rule is in effect. If unspecified or null, the schedule will always be in effect.
    type string
    The type of system resource this rule limits.
    description str
    User-entered description of this performance rule.
    enabled bool
    Whether this performance rule is currently in effect during its specified intervals.
    id str
    The system ID given to this performance rule.
    limit float
    Amount the specified system resource type is limited by this rule. Units are kb/s for bandwidth, files/s for file-count, processing percentage used for cpu, or percentage of maximum available workers.
    schedule GetSynciqRuleRuleSchedule
    A schedule defining when during a week this performance rule is in effect. If unspecified or null, the schedule will always be in effect.
    type str
    The type of system resource this rule limits.
    description String
    User-entered description of this performance rule.
    enabled Boolean
    Whether this performance rule is currently in effect during its specified intervals.
    id String
    The system ID given to this performance rule.
    limit Number
    Amount the specified system resource type is limited by this rule. Units are kb/s for bandwidth, files/s for file-count, processing percentage used for cpu, or percentage of maximum available workers.
    schedule Property Map
    A schedule defining when during a week this performance rule is in effect. If unspecified or null, the schedule will always be in effect.
    type String
    The type of system resource this rule limits.

    GetSynciqRuleRuleSchedule

    Begin string
    Start time (inclusive) for this schedule, during its specified days. Format is "hh:mm" (24h format hour, and minute). A null value indicates the beginning of the day ("00:00").
    End string
    End time (inclusive) for this schedule, during its specified days. Format is "hh:mm" (three-letter weekday name abbreviation, 24h format hour, and minute). A null value indicates the end of the day ("23:59").
    Friday bool
    If true, this rule is in effect on Friday. If false, or unspecified, it is not.
    Monday bool
    If true, this rule is in effect on Monday. If false, or unspecified, it is not.
    Saturday bool
    If true, this rule is in effect on Saturday. If false, or unspecified, it is not.
    Sunday bool
    If true, this rule is in effect on Sunday. If false, or unspecified, it is not.
    Thursday bool
    If true, this rule is in effect on Thursday. If false, or unspecified, it is not.
    Tuesday bool
    If true, this rule is in effect on Tuesday. If false, or unspecified, it is not.
    Wednesday bool
    If true, this rule is in effect on Wednesday. If false, or unspecified, it is not.
    Begin string
    Start time (inclusive) for this schedule, during its specified days. Format is "hh:mm" (24h format hour, and minute). A null value indicates the beginning of the day ("00:00").
    End string
    End time (inclusive) for this schedule, during its specified days. Format is "hh:mm" (three-letter weekday name abbreviation, 24h format hour, and minute). A null value indicates the end of the day ("23:59").
    Friday bool
    If true, this rule is in effect on Friday. If false, or unspecified, it is not.
    Monday bool
    If true, this rule is in effect on Monday. If false, or unspecified, it is not.
    Saturday bool
    If true, this rule is in effect on Saturday. If false, or unspecified, it is not.
    Sunday bool
    If true, this rule is in effect on Sunday. If false, or unspecified, it is not.
    Thursday bool
    If true, this rule is in effect on Thursday. If false, or unspecified, it is not.
    Tuesday bool
    If true, this rule is in effect on Tuesday. If false, or unspecified, it is not.
    Wednesday bool
    If true, this rule is in effect on Wednesday. If false, or unspecified, it is not.
    begin String
    Start time (inclusive) for this schedule, during its specified days. Format is "hh:mm" (24h format hour, and minute). A null value indicates the beginning of the day ("00:00").
    end String
    End time (inclusive) for this schedule, during its specified days. Format is "hh:mm" (three-letter weekday name abbreviation, 24h format hour, and minute). A null value indicates the end of the day ("23:59").
    friday Boolean
    If true, this rule is in effect on Friday. If false, or unspecified, it is not.
    monday Boolean
    If true, this rule is in effect on Monday. If false, or unspecified, it is not.
    saturday Boolean
    If true, this rule is in effect on Saturday. If false, or unspecified, it is not.
    sunday Boolean
    If true, this rule is in effect on Sunday. If false, or unspecified, it is not.
    thursday Boolean
    If true, this rule is in effect on Thursday. If false, or unspecified, it is not.
    tuesday Boolean
    If true, this rule is in effect on Tuesday. If false, or unspecified, it is not.
    wednesday Boolean
    If true, this rule is in effect on Wednesday. If false, or unspecified, it is not.
    begin string
    Start time (inclusive) for this schedule, during its specified days. Format is "hh:mm" (24h format hour, and minute). A null value indicates the beginning of the day ("00:00").
    end string
    End time (inclusive) for this schedule, during its specified days. Format is "hh:mm" (three-letter weekday name abbreviation, 24h format hour, and minute). A null value indicates the end of the day ("23:59").
    friday boolean
    If true, this rule is in effect on Friday. If false, or unspecified, it is not.
    monday boolean
    If true, this rule is in effect on Monday. If false, or unspecified, it is not.
    saturday boolean
    If true, this rule is in effect on Saturday. If false, or unspecified, it is not.
    sunday boolean
    If true, this rule is in effect on Sunday. If false, or unspecified, it is not.
    thursday boolean
    If true, this rule is in effect on Thursday. If false, or unspecified, it is not.
    tuesday boolean
    If true, this rule is in effect on Tuesday. If false, or unspecified, it is not.
    wednesday boolean
    If true, this rule is in effect on Wednesday. If false, or unspecified, it is not.
    begin str
    Start time (inclusive) for this schedule, during its specified days. Format is "hh:mm" (24h format hour, and minute). A null value indicates the beginning of the day ("00:00").
    end str
    End time (inclusive) for this schedule, during its specified days. Format is "hh:mm" (three-letter weekday name abbreviation, 24h format hour, and minute). A null value indicates the end of the day ("23:59").
    friday bool
    If true, this rule is in effect on Friday. If false, or unspecified, it is not.
    monday bool
    If true, this rule is in effect on Monday. If false, or unspecified, it is not.
    saturday bool
    If true, this rule is in effect on Saturday. If false, or unspecified, it is not.
    sunday bool
    If true, this rule is in effect on Sunday. If false, or unspecified, it is not.
    thursday bool
    If true, this rule is in effect on Thursday. If false, or unspecified, it is not.
    tuesday bool
    If true, this rule is in effect on Tuesday. If false, or unspecified, it is not.
    wednesday bool
    If true, this rule is in effect on Wednesday. If false, or unspecified, it is not.
    begin String
    Start time (inclusive) for this schedule, during its specified days. Format is "hh:mm" (24h format hour, and minute). A null value indicates the beginning of the day ("00:00").
    end String
    End time (inclusive) for this schedule, during its specified days. Format is "hh:mm" (three-letter weekday name abbreviation, 24h format hour, and minute). A null value indicates the end of the day ("23:59").
    friday Boolean
    If true, this rule is in effect on Friday. If false, or unspecified, it is not.
    monday Boolean
    If true, this rule is in effect on Monday. If false, or unspecified, it is not.
    saturday Boolean
    If true, this rule is in effect on Saturday. If false, or unspecified, it is not.
    sunday Boolean
    If true, this rule is in effect on Sunday. If false, or unspecified, it is not.
    thursday Boolean
    If true, this rule is in effect on Thursday. If false, or unspecified, it is not.
    tuesday Boolean
    If true, this rule is in effect on Tuesday. If false, or unspecified, it is not.
    wednesday Boolean
    If true, this rule is in effect on Wednesday. If false, or unspecified, it is not.

    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