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

powerscale.getSynciqGlobalSettings

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 SyncIQ Global Settings from PowerScale array. The information fetched from this datasource can be used for getting the details.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as powerscale from "@pulumi/powerscale";
    
    const all = powerscale.getSynciqGlobalSettings({});
    export const powerscaleSynciqGlobalSettingsAll = all;
    
    import pulumi
    import pulumi_powerscale as powerscale
    
    all = powerscale.get_synciq_global_settings()
    pulumi.export("powerscaleSynciqGlobalSettingsAll", all)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/powerscale/powerscale"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		all, err := powerscale.LookupSynciqGlobalSettings(ctx, map[string]interface{}{}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("powerscaleSynciqGlobalSettingsAll", all)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Powerscale = Pulumi.Powerscale;
    
    return await Deployment.RunAsync(() => 
    {
        var all = Powerscale.GetSynciqGlobalSettings.Invoke();
    
        return new Dictionary<string, object?>
        {
            ["powerscaleSynciqGlobalSettingsAll"] = all,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.powerscale.PowerscaleFunctions;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var all = PowerscaleFunctions.getSynciqGlobalSettings();
    
            ctx.export("powerscaleSynciqGlobalSettingsAll", all.applyValue(getSynciqGlobalSettingsResult -> getSynciqGlobalSettingsResult));
        }
    }
    
    variables:
      all:
        fn::invoke:
          function: powerscale:getSynciqGlobalSettings
          arguments: {}
    outputs:
      # Output value of above block by executing 'terraform output' command
      # You can use the the fetched information by the variable data.powerscale_synciq_global_settings.all
      powerscaleSynciqGlobalSettingsAll: ${all}
    

    Using getSynciqGlobalSettings

    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 getSynciqGlobalSettings(opts?: InvokeOptions): Promise<GetSynciqGlobalSettingsResult>
    function getSynciqGlobalSettingsOutput(opts?: InvokeOptions): Output<GetSynciqGlobalSettingsResult>
    def get_synciq_global_settings(opts: Optional[InvokeOptions] = None) -> GetSynciqGlobalSettingsResult
    def get_synciq_global_settings_output(opts: Optional[InvokeOptions] = None) -> Output[GetSynciqGlobalSettingsResult]
    func LookupSynciqGlobalSettings(ctx *Context, opts ...InvokeOption) (*LookupSynciqGlobalSettingsResult, error)
    func LookupSynciqGlobalSettingsOutput(ctx *Context, opts ...InvokeOption) LookupSynciqGlobalSettingsResultOutput

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

    public static class GetSynciqGlobalSettings 
    {
        public static Task<GetSynciqGlobalSettingsResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetSynciqGlobalSettingsResult> Invoke(InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSynciqGlobalSettingsResult> getSynciqGlobalSettings(InvokeOptions options)
    public static Output<GetSynciqGlobalSettingsResult> getSynciqGlobalSettings(InvokeOptions options)
    
    fn::invoke:
      function: powerscale:index/getSynciqGlobalSettings:getSynciqGlobalSettings
      arguments:
        # arguments dictionary

    getSynciqGlobalSettings Result

    The following output properties are available:

    BandwidthReservationReserveAbsolute double
    The amount of SyncIQ bandwidth to reserve in kb/s for policies that did not specify a bandwidth reservation. This field takes precedence over bandwidthreservationreserve_percentage.
    BandwidthReservationReservePercentage double
    The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.
    ClusterCertificateId string
    The ID of this cluster's certificate being used for encryption.
    EncryptionCipherList string
    The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.
    EncryptionRequired bool
    If true, requires all SyncIQ policies to utilize encrypted communications.
    ForceInterface bool
    NOTE: This field should not be changed without the help of PowerScale support. Default for the "forceinterface" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. Determines whether data is sent only through the subnet and pool specified in the "sourcenetwork" field. This option can be useful if there are multiple interfaces for the given source subnet.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaxConcurrentJobs double
    The max concurrent jobs that SyncIQ can support. This number is based on the size of the current cluster and the current SyncIQ worker throttle rule.
    OcspAddress string
    The address of the OCSP responder to which to connect.
    OcspIssuerCertificateId string
    The ID of the certificate authority that issued the certificate whose revocation status is being checked.
    PasswordSet bool
    Indicates if a password is set for authentication. Password value is not shown with GET.
    PreferredRpoAlert double
    If specified, display as default RPO Alert value for new policy creation via WebUI
    RenegotiationPeriod double
    If specified, the duration to persist encrypted connection before forcing a renegotiation.
    ReportEmails List<string>
    Email sync reports to these addresses.
    ReportMaxAge double
    The default length of time (in seconds) a policy report will be stored.
    ReportMaxCount double
    The default maximum number of reports to retain for a policy.
    RestrictTargetNetwork bool
    Default for the "restricttargetnetwork" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. If you specify true, and you specify a SmartConnect zone in the "target_host" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.
    RpoAlerts bool
    If disabled, no RPO alerts will be generated.
    Service string
    Specifies if the SyncIQ service currently on, paused, or off. If paused, all sync jobs will be paused. If turned off, all jobs will be canceled.
    ServiceHistoryMaxAge double
    Maximum age of service information to maintain, in seconds.
    ServiceHistoryMaxCount double
    Maximum number of historical service information records to maintain.
    SourceNetwork GetSynciqGlobalSettingsSourceNetwork
    Restricts replication policies on the local cluster to running on the specified subnet and pool.
    TwChkptInterval double
    The interval (in seconds) in which treewalk syncs are forced to checkpoint.
    UseWorkersPerNode bool
    If enabled, SyncIQ will use the deprecated workerspernode field with worker pools functionality and limit workers accordingly.
    BandwidthReservationReserveAbsolute float64
    The amount of SyncIQ bandwidth to reserve in kb/s for policies that did not specify a bandwidth reservation. This field takes precedence over bandwidthreservationreserve_percentage.
    BandwidthReservationReservePercentage float64
    The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.
    ClusterCertificateId string
    The ID of this cluster's certificate being used for encryption.
    EncryptionCipherList string
    The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.
    EncryptionRequired bool
    If true, requires all SyncIQ policies to utilize encrypted communications.
    ForceInterface bool
    NOTE: This field should not be changed without the help of PowerScale support. Default for the "forceinterface" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. Determines whether data is sent only through the subnet and pool specified in the "sourcenetwork" field. This option can be useful if there are multiple interfaces for the given source subnet.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaxConcurrentJobs float64
    The max concurrent jobs that SyncIQ can support. This number is based on the size of the current cluster and the current SyncIQ worker throttle rule.
    OcspAddress string
    The address of the OCSP responder to which to connect.
    OcspIssuerCertificateId string
    The ID of the certificate authority that issued the certificate whose revocation status is being checked.
    PasswordSet bool
    Indicates if a password is set for authentication. Password value is not shown with GET.
    PreferredRpoAlert float64
    If specified, display as default RPO Alert value for new policy creation via WebUI
    RenegotiationPeriod float64
    If specified, the duration to persist encrypted connection before forcing a renegotiation.
    ReportEmails []string
    Email sync reports to these addresses.
    ReportMaxAge float64
    The default length of time (in seconds) a policy report will be stored.
    ReportMaxCount float64
    The default maximum number of reports to retain for a policy.
    RestrictTargetNetwork bool
    Default for the "restricttargetnetwork" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. If you specify true, and you specify a SmartConnect zone in the "target_host" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.
    RpoAlerts bool
    If disabled, no RPO alerts will be generated.
    Service string
    Specifies if the SyncIQ service currently on, paused, or off. If paused, all sync jobs will be paused. If turned off, all jobs will be canceled.
    ServiceHistoryMaxAge float64
    Maximum age of service information to maintain, in seconds.
    ServiceHistoryMaxCount float64
    Maximum number of historical service information records to maintain.
    SourceNetwork GetSynciqGlobalSettingsSourceNetwork
    Restricts replication policies on the local cluster to running on the specified subnet and pool.
    TwChkptInterval float64
    The interval (in seconds) in which treewalk syncs are forced to checkpoint.
    UseWorkersPerNode bool
    If enabled, SyncIQ will use the deprecated workerspernode field with worker pools functionality and limit workers accordingly.
    bandwidthReservationReserveAbsolute Double
    The amount of SyncIQ bandwidth to reserve in kb/s for policies that did not specify a bandwidth reservation. This field takes precedence over bandwidthreservationreserve_percentage.
    bandwidthReservationReservePercentage Double
    The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.
    clusterCertificateId String
    The ID of this cluster's certificate being used for encryption.
    encryptionCipherList String
    The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.
    encryptionRequired Boolean
    If true, requires all SyncIQ policies to utilize encrypted communications.
    forceInterface Boolean
    NOTE: This field should not be changed without the help of PowerScale support. Default for the "forceinterface" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. Determines whether data is sent only through the subnet and pool specified in the "sourcenetwork" field. This option can be useful if there are multiple interfaces for the given source subnet.
    id String
    The provider-assigned unique ID for this managed resource.
    maxConcurrentJobs Double
    The max concurrent jobs that SyncIQ can support. This number is based on the size of the current cluster and the current SyncIQ worker throttle rule.
    ocspAddress String
    The address of the OCSP responder to which to connect.
    ocspIssuerCertificateId String
    The ID of the certificate authority that issued the certificate whose revocation status is being checked.
    passwordSet Boolean
    Indicates if a password is set for authentication. Password value is not shown with GET.
    preferredRpoAlert Double
    If specified, display as default RPO Alert value for new policy creation via WebUI
    renegotiationPeriod Double
    If specified, the duration to persist encrypted connection before forcing a renegotiation.
    reportEmails List<String>
    Email sync reports to these addresses.
    reportMaxAge Double
    The default length of time (in seconds) a policy report will be stored.
    reportMaxCount Double
    The default maximum number of reports to retain for a policy.
    restrictTargetNetwork Boolean
    Default for the "restricttargetnetwork" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. If you specify true, and you specify a SmartConnect zone in the "target_host" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.
    rpoAlerts Boolean
    If disabled, no RPO alerts will be generated.
    service String
    Specifies if the SyncIQ service currently on, paused, or off. If paused, all sync jobs will be paused. If turned off, all jobs will be canceled.
    serviceHistoryMaxAge Double
    Maximum age of service information to maintain, in seconds.
    serviceHistoryMaxCount Double
    Maximum number of historical service information records to maintain.
    sourceNetwork GetSynciqGlobalSettingsSourceNetwork
    Restricts replication policies on the local cluster to running on the specified subnet and pool.
    twChkptInterval Double
    The interval (in seconds) in which treewalk syncs are forced to checkpoint.
    useWorkersPerNode Boolean
    If enabled, SyncIQ will use the deprecated workerspernode field with worker pools functionality and limit workers accordingly.
    bandwidthReservationReserveAbsolute number
    The amount of SyncIQ bandwidth to reserve in kb/s for policies that did not specify a bandwidth reservation. This field takes precedence over bandwidthreservationreserve_percentage.
    bandwidthReservationReservePercentage number
    The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.
    clusterCertificateId string
    The ID of this cluster's certificate being used for encryption.
    encryptionCipherList string
    The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.
    encryptionRequired boolean
    If true, requires all SyncIQ policies to utilize encrypted communications.
    forceInterface boolean
    NOTE: This field should not be changed without the help of PowerScale support. Default for the "forceinterface" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. Determines whether data is sent only through the subnet and pool specified in the "sourcenetwork" field. This option can be useful if there are multiple interfaces for the given source subnet.
    id string
    The provider-assigned unique ID for this managed resource.
    maxConcurrentJobs number
    The max concurrent jobs that SyncIQ can support. This number is based on the size of the current cluster and the current SyncIQ worker throttle rule.
    ocspAddress string
    The address of the OCSP responder to which to connect.
    ocspIssuerCertificateId string
    The ID of the certificate authority that issued the certificate whose revocation status is being checked.
    passwordSet boolean
    Indicates if a password is set for authentication. Password value is not shown with GET.
    preferredRpoAlert number
    If specified, display as default RPO Alert value for new policy creation via WebUI
    renegotiationPeriod number
    If specified, the duration to persist encrypted connection before forcing a renegotiation.
    reportEmails string[]
    Email sync reports to these addresses.
    reportMaxAge number
    The default length of time (in seconds) a policy report will be stored.
    reportMaxCount number
    The default maximum number of reports to retain for a policy.
    restrictTargetNetwork boolean
    Default for the "restricttargetnetwork" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. If you specify true, and you specify a SmartConnect zone in the "target_host" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.
    rpoAlerts boolean
    If disabled, no RPO alerts will be generated.
    service string
    Specifies if the SyncIQ service currently on, paused, or off. If paused, all sync jobs will be paused. If turned off, all jobs will be canceled.
    serviceHistoryMaxAge number
    Maximum age of service information to maintain, in seconds.
    serviceHistoryMaxCount number
    Maximum number of historical service information records to maintain.
    sourceNetwork GetSynciqGlobalSettingsSourceNetwork
    Restricts replication policies on the local cluster to running on the specified subnet and pool.
    twChkptInterval number
    The interval (in seconds) in which treewalk syncs are forced to checkpoint.
    useWorkersPerNode boolean
    If enabled, SyncIQ will use the deprecated workerspernode field with worker pools functionality and limit workers accordingly.
    bandwidth_reservation_reserve_absolute float
    The amount of SyncIQ bandwidth to reserve in kb/s for policies that did not specify a bandwidth reservation. This field takes precedence over bandwidthreservationreserve_percentage.
    bandwidth_reservation_reserve_percentage float
    The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.
    cluster_certificate_id str
    The ID of this cluster's certificate being used for encryption.
    encryption_cipher_list str
    The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.
    encryption_required bool
    If true, requires all SyncIQ policies to utilize encrypted communications.
    force_interface bool
    NOTE: This field should not be changed without the help of PowerScale support. Default for the "forceinterface" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. Determines whether data is sent only through the subnet and pool specified in the "sourcenetwork" field. This option can be useful if there are multiple interfaces for the given source subnet.
    id str
    The provider-assigned unique ID for this managed resource.
    max_concurrent_jobs float
    The max concurrent jobs that SyncIQ can support. This number is based on the size of the current cluster and the current SyncIQ worker throttle rule.
    ocsp_address str
    The address of the OCSP responder to which to connect.
    ocsp_issuer_certificate_id str
    The ID of the certificate authority that issued the certificate whose revocation status is being checked.
    password_set bool
    Indicates if a password is set for authentication. Password value is not shown with GET.
    preferred_rpo_alert float
    If specified, display as default RPO Alert value for new policy creation via WebUI
    renegotiation_period float
    If specified, the duration to persist encrypted connection before forcing a renegotiation.
    report_emails Sequence[str]
    Email sync reports to these addresses.
    report_max_age float
    The default length of time (in seconds) a policy report will be stored.
    report_max_count float
    The default maximum number of reports to retain for a policy.
    restrict_target_network bool
    Default for the "restricttargetnetwork" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. If you specify true, and you specify a SmartConnect zone in the "target_host" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.
    rpo_alerts bool
    If disabled, no RPO alerts will be generated.
    service str
    Specifies if the SyncIQ service currently on, paused, or off. If paused, all sync jobs will be paused. If turned off, all jobs will be canceled.
    service_history_max_age float
    Maximum age of service information to maintain, in seconds.
    service_history_max_count float
    Maximum number of historical service information records to maintain.
    source_network GetSynciqGlobalSettingsSourceNetwork
    Restricts replication policies on the local cluster to running on the specified subnet and pool.
    tw_chkpt_interval float
    The interval (in seconds) in which treewalk syncs are forced to checkpoint.
    use_workers_per_node bool
    If enabled, SyncIQ will use the deprecated workerspernode field with worker pools functionality and limit workers accordingly.
    bandwidthReservationReserveAbsolute Number
    The amount of SyncIQ bandwidth to reserve in kb/s for policies that did not specify a bandwidth reservation. This field takes precedence over bandwidthreservationreserve_percentage.
    bandwidthReservationReservePercentage Number
    The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.
    clusterCertificateId String
    The ID of this cluster's certificate being used for encryption.
    encryptionCipherList String
    The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.
    encryptionRequired Boolean
    If true, requires all SyncIQ policies to utilize encrypted communications.
    forceInterface Boolean
    NOTE: This field should not be changed without the help of PowerScale support. Default for the "forceinterface" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. Determines whether data is sent only through the subnet and pool specified in the "sourcenetwork" field. This option can be useful if there are multiple interfaces for the given source subnet.
    id String
    The provider-assigned unique ID for this managed resource.
    maxConcurrentJobs Number
    The max concurrent jobs that SyncIQ can support. This number is based on the size of the current cluster and the current SyncIQ worker throttle rule.
    ocspAddress String
    The address of the OCSP responder to which to connect.
    ocspIssuerCertificateId String
    The ID of the certificate authority that issued the certificate whose revocation status is being checked.
    passwordSet Boolean
    Indicates if a password is set for authentication. Password value is not shown with GET.
    preferredRpoAlert Number
    If specified, display as default RPO Alert value for new policy creation via WebUI
    renegotiationPeriod Number
    If specified, the duration to persist encrypted connection before forcing a renegotiation.
    reportEmails List<String>
    Email sync reports to these addresses.
    reportMaxAge Number
    The default length of time (in seconds) a policy report will be stored.
    reportMaxCount Number
    The default maximum number of reports to retain for a policy.
    restrictTargetNetwork Boolean
    Default for the "restricttargetnetwork" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. If you specify true, and you specify a SmartConnect zone in the "target_host" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.
    rpoAlerts Boolean
    If disabled, no RPO alerts will be generated.
    service String
    Specifies if the SyncIQ service currently on, paused, or off. If paused, all sync jobs will be paused. If turned off, all jobs will be canceled.
    serviceHistoryMaxAge Number
    Maximum age of service information to maintain, in seconds.
    serviceHistoryMaxCount Number
    Maximum number of historical service information records to maintain.
    sourceNetwork Property Map
    Restricts replication policies on the local cluster to running on the specified subnet and pool.
    twChkptInterval Number
    The interval (in seconds) in which treewalk syncs are forced to checkpoint.
    useWorkersPerNode Boolean
    If enabled, SyncIQ will use the deprecated workerspernode field with worker pools functionality and limit workers accordingly.

    Supporting Types

    GetSynciqGlobalSettingsSourceNetwork

    Pool string
    The pool to restrict replication policies to.
    Subnet string
    The subnet to restrict replication policies to.
    Pool string
    The pool to restrict replication policies to.
    Subnet string
    The subnet to restrict replication policies to.
    pool String
    The pool to restrict replication policies to.
    subnet String
    The subnet to restrict replication policies to.
    pool string
    The pool to restrict replication policies to.
    subnet string
    The subnet to restrict replication policies to.
    pool str
    The pool to restrict replication policies to.
    subnet str
    The subnet to restrict replication policies to.
    pool String
    The pool to restrict replication policies to.
    subnet String
    The subnet to restrict replication policies to.

    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