powerscale.SynciqGlobalSettings
Explore with Pulumi AI
This resource is used to manage the SyncIQ Global Settings entity of PowerScale Array. We can Update the SyncIQ Global Settings using this resource. We can also import existing SyncIQ Global Settings from PowerScale array.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as powerscale from "@pulumi/powerscale";
// PowerScale SynIQ global settings allows you to manage the global settings on the Powerscale array
const example = new powerscale.SynciqGlobalSettings("example", {
preferredRpoAlert: 3,
renegotiationPeriod: 28800,
reportEmails: [
"example1@mail.com",
"example2@mail.com",
],
reportMaxCount: 2000,
restrictTargetNetwork: true,
rpoAlerts: true,
service: "paused",
sourceNetwork: {
pool: "pool0",
subnet: "subnet0",
},
});
import pulumi
import pulumi_powerscale as powerscale
# PowerScale SynIQ global settings allows you to manage the global settings on the Powerscale array
example = powerscale.SynciqGlobalSettings("example",
preferred_rpo_alert=3,
renegotiation_period=28800,
report_emails=[
"example1@mail.com",
"example2@mail.com",
],
report_max_count=2000,
restrict_target_network=True,
rpo_alerts=True,
service="paused",
source_network={
"pool": "pool0",
"subnet": "subnet0",
})
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 {
// PowerScale SynIQ global settings allows you to manage the global settings on the Powerscale array
_, err := powerscale.NewSynciqGlobalSettings(ctx, "example", &powerscale.SynciqGlobalSettingsArgs{
PreferredRpoAlert: pulumi.Float64(3),
RenegotiationPeriod: pulumi.Float64(28800),
ReportEmails: pulumi.StringArray{
pulumi.String("example1@mail.com"),
pulumi.String("example2@mail.com"),
},
ReportMaxCount: pulumi.Float64(2000),
RestrictTargetNetwork: pulumi.Bool(true),
RpoAlerts: pulumi.Bool(true),
Service: pulumi.String("paused"),
SourceNetwork: &powerscale.SynciqGlobalSettingsSourceNetworkArgs{
Pool: pulumi.String("pool0"),
Subnet: pulumi.String("subnet0"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Powerscale = Pulumi.Powerscale;
return await Deployment.RunAsync(() =>
{
// PowerScale SynIQ global settings allows you to manage the global settings on the Powerscale array
var example = new Powerscale.SynciqGlobalSettings("example", new()
{
PreferredRpoAlert = 3,
RenegotiationPeriod = 28800,
ReportEmails = new[]
{
"example1@mail.com",
"example2@mail.com",
},
ReportMaxCount = 2000,
RestrictTargetNetwork = true,
RpoAlerts = true,
Service = "paused",
SourceNetwork = new Powerscale.Inputs.SynciqGlobalSettingsSourceNetworkArgs
{
Pool = "pool0",
Subnet = "subnet0",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.powerscale.SynciqGlobalSettings;
import com.pulumi.powerscale.SynciqGlobalSettingsArgs;
import com.pulumi.powerscale.inputs.SynciqGlobalSettingsSourceNetworkArgs;
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) {
// PowerScale SynIQ global settings allows you to manage the global settings on the Powerscale array
var example = new SynciqGlobalSettings("example", SynciqGlobalSettingsArgs.builder()
.preferredRpoAlert(3)
.renegotiationPeriod(28800)
.reportEmails(
"example1@mail.com",
"example2@mail.com")
.reportMaxCount(2000)
.restrictTargetNetwork(true)
.rpoAlerts(true)
.service("paused")
.sourceNetwork(SynciqGlobalSettingsSourceNetworkArgs.builder()
.pool("pool0")
.subnet("subnet0")
.build())
.build());
}
}
resources:
# PowerScale SynIQ global settings allows you to manage the global settings on the Powerscale array
example:
type: powerscale:SynciqGlobalSettings
properties:
preferredRpoAlert: 3
renegotiationPeriod: 28800
reportEmails:
- example1@mail.com
- example2@mail.com
reportMaxCount: 2000
restrictTargetNetwork: true
rpoAlerts: true
service: paused
sourceNetwork:
pool: pool0
subnet: subnet0
Create SynciqGlobalSettings Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SynciqGlobalSettings(name: string, args?: SynciqGlobalSettingsArgs, opts?: CustomResourceOptions);
@overload
def SynciqGlobalSettings(resource_name: str,
args: Optional[SynciqGlobalSettingsArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def SynciqGlobalSettings(resource_name: str,
opts: Optional[ResourceOptions] = None,
bandwidth_reservation_reserve_absolute: Optional[float] = None,
bandwidth_reservation_reserve_percentage: Optional[float] = None,
cluster_certificate_id: Optional[str] = None,
encryption_cipher_list: Optional[str] = None,
encryption_required: Optional[bool] = None,
force_interface: Optional[bool] = None,
ocsp_address: Optional[str] = None,
ocsp_issuer_certificate_id: Optional[str] = None,
preferred_rpo_alert: Optional[float] = None,
renegotiation_period: Optional[float] = None,
report_emails: Optional[Sequence[str]] = None,
report_max_age: Optional[float] = None,
report_max_count: Optional[float] = None,
restrict_target_network: Optional[bool] = None,
rpo_alerts: Optional[bool] = None,
service: Optional[str] = None,
service_history_max_age: Optional[float] = None,
service_history_max_count: Optional[float] = None,
source_network: Optional[SynciqGlobalSettingsSourceNetworkArgs] = None,
use_workers_per_node: Optional[bool] = None)
func NewSynciqGlobalSettings(ctx *Context, name string, args *SynciqGlobalSettingsArgs, opts ...ResourceOption) (*SynciqGlobalSettings, error)
public SynciqGlobalSettings(string name, SynciqGlobalSettingsArgs? args = null, CustomResourceOptions? opts = null)
public SynciqGlobalSettings(String name, SynciqGlobalSettingsArgs args)
public SynciqGlobalSettings(String name, SynciqGlobalSettingsArgs args, CustomResourceOptions options)
type: powerscale:SynciqGlobalSettings
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args SynciqGlobalSettingsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SynciqGlobalSettingsArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SynciqGlobalSettingsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SynciqGlobalSettingsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SynciqGlobalSettingsArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var synciqGlobalSettingsResource = new Powerscale.SynciqGlobalSettings("synciqGlobalSettingsResource", new()
{
BandwidthReservationReserveAbsolute = 0,
BandwidthReservationReservePercentage = 0,
ClusterCertificateId = "string",
EncryptionCipherList = "string",
EncryptionRequired = false,
ForceInterface = false,
OcspAddress = "string",
OcspIssuerCertificateId = "string",
PreferredRpoAlert = 0,
RenegotiationPeriod = 0,
ReportEmails = new[]
{
"string",
},
ReportMaxAge = 0,
ReportMaxCount = 0,
RestrictTargetNetwork = false,
RpoAlerts = false,
Service = "string",
ServiceHistoryMaxAge = 0,
ServiceHistoryMaxCount = 0,
SourceNetwork = new Powerscale.Inputs.SynciqGlobalSettingsSourceNetworkArgs
{
Pool = "string",
Subnet = "string",
},
UseWorkersPerNode = false,
});
example, err := powerscale.NewSynciqGlobalSettings(ctx, "synciqGlobalSettingsResource", &powerscale.SynciqGlobalSettingsArgs{
BandwidthReservationReserveAbsolute: pulumi.Float64(0),
BandwidthReservationReservePercentage: pulumi.Float64(0),
ClusterCertificateId: pulumi.String("string"),
EncryptionCipherList: pulumi.String("string"),
EncryptionRequired: pulumi.Bool(false),
ForceInterface: pulumi.Bool(false),
OcspAddress: pulumi.String("string"),
OcspIssuerCertificateId: pulumi.String("string"),
PreferredRpoAlert: pulumi.Float64(0),
RenegotiationPeriod: pulumi.Float64(0),
ReportEmails: pulumi.StringArray{
pulumi.String("string"),
},
ReportMaxAge: pulumi.Float64(0),
ReportMaxCount: pulumi.Float64(0),
RestrictTargetNetwork: pulumi.Bool(false),
RpoAlerts: pulumi.Bool(false),
Service: pulumi.String("string"),
ServiceHistoryMaxAge: pulumi.Float64(0),
ServiceHistoryMaxCount: pulumi.Float64(0),
SourceNetwork: &powerscale.SynciqGlobalSettingsSourceNetworkArgs{
Pool: pulumi.String("string"),
Subnet: pulumi.String("string"),
},
UseWorkersPerNode: pulumi.Bool(false),
})
var synciqGlobalSettingsResource = new SynciqGlobalSettings("synciqGlobalSettingsResource", SynciqGlobalSettingsArgs.builder()
.bandwidthReservationReserveAbsolute(0)
.bandwidthReservationReservePercentage(0)
.clusterCertificateId("string")
.encryptionCipherList("string")
.encryptionRequired(false)
.forceInterface(false)
.ocspAddress("string")
.ocspIssuerCertificateId("string")
.preferredRpoAlert(0)
.renegotiationPeriod(0)
.reportEmails("string")
.reportMaxAge(0)
.reportMaxCount(0)
.restrictTargetNetwork(false)
.rpoAlerts(false)
.service("string")
.serviceHistoryMaxAge(0)
.serviceHistoryMaxCount(0)
.sourceNetwork(SynciqGlobalSettingsSourceNetworkArgs.builder()
.pool("string")
.subnet("string")
.build())
.useWorkersPerNode(false)
.build());
synciq_global_settings_resource = powerscale.SynciqGlobalSettings("synciqGlobalSettingsResource",
bandwidth_reservation_reserve_absolute=0,
bandwidth_reservation_reserve_percentage=0,
cluster_certificate_id="string",
encryption_cipher_list="string",
encryption_required=False,
force_interface=False,
ocsp_address="string",
ocsp_issuer_certificate_id="string",
preferred_rpo_alert=0,
renegotiation_period=0,
report_emails=["string"],
report_max_age=0,
report_max_count=0,
restrict_target_network=False,
rpo_alerts=False,
service="string",
service_history_max_age=0,
service_history_max_count=0,
source_network={
"pool": "string",
"subnet": "string",
},
use_workers_per_node=False)
const synciqGlobalSettingsResource = new powerscale.SynciqGlobalSettings("synciqGlobalSettingsResource", {
bandwidthReservationReserveAbsolute: 0,
bandwidthReservationReservePercentage: 0,
clusterCertificateId: "string",
encryptionCipherList: "string",
encryptionRequired: false,
forceInterface: false,
ocspAddress: "string",
ocspIssuerCertificateId: "string",
preferredRpoAlert: 0,
renegotiationPeriod: 0,
reportEmails: ["string"],
reportMaxAge: 0,
reportMaxCount: 0,
restrictTargetNetwork: false,
rpoAlerts: false,
service: "string",
serviceHistoryMaxAge: 0,
serviceHistoryMaxCount: 0,
sourceNetwork: {
pool: "string",
subnet: "string",
},
useWorkersPerNode: false,
});
type: powerscale:SynciqGlobalSettings
properties:
bandwidthReservationReserveAbsolute: 0
bandwidthReservationReservePercentage: 0
clusterCertificateId: string
encryptionCipherList: string
encryptionRequired: false
forceInterface: false
ocspAddress: string
ocspIssuerCertificateId: string
preferredRpoAlert: 0
renegotiationPeriod: 0
reportEmails:
- string
reportMaxAge: 0
reportMaxCount: 0
restrictTargetNetwork: false
rpoAlerts: false
service: string
serviceHistoryMaxAge: 0
serviceHistoryMaxCount: 0
sourceNetwork:
pool: string
subnet: string
useWorkersPerNode: false
SynciqGlobalSettings Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SynciqGlobalSettings resource accepts the following input properties:
- Bandwidth
Reservation doubleReserve Absolute - 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 doubleReserve Percentage - The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.
- Cluster
Certificate stringId - The ID of this cluster's certificate being used for encryption.
- Encryption
Cipher stringList - 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.
- Ocsp
Address string - The address of the OCSP responder to which to connect.
- Ocsp
Issuer stringCertificate Id - The ID of the certificate authority that issued the certificate whose revocation status is being checked.
- Preferred
Rpo doubleAlert - If specified, display as default RPO Alert value for new policy creation via WebUI.
- Renegotiation
Period double - If specified, the duration to persist encrypted connection before forcing a renegotiation.
- Report
Emails List<string> - Email sync reports to these addresses.
- Report
Max doubleAge - ID of the Cluster Email Settings.
- Report
Max doubleCount - The default length of time (in seconds) a policy report will be stored.
- Restrict
Target boolNetwork - 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 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.
- Service
History doubleMax Age - Maximum age of service information to maintain, in seconds.
- Service
History doubleMax Count - Maximum number of historical service information records to maintain.
- Source
Network SynciqGlobal Settings Source Network - Restricts replication policies on the local cluster to running on the specified subnet and pool.
- Use
Workers boolPer Node - If enabled, SyncIQ will use the deprecated workerspernode field with worker pools functionality and limit workers accordingly.
- Bandwidth
Reservation float64Reserve Absolute - 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 float64Reserve Percentage - The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.
- Cluster
Certificate stringId - The ID of this cluster's certificate being used for encryption.
- Encryption
Cipher stringList - 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.
- Ocsp
Address string - The address of the OCSP responder to which to connect.
- Ocsp
Issuer stringCertificate Id - The ID of the certificate authority that issued the certificate whose revocation status is being checked.
- Preferred
Rpo float64Alert - If specified, display as default RPO Alert value for new policy creation via WebUI.
- Renegotiation
Period float64 - If specified, the duration to persist encrypted connection before forcing a renegotiation.
- Report
Emails []string - Email sync reports to these addresses.
- Report
Max float64Age - ID of the Cluster Email Settings.
- Report
Max float64Count - The default length of time (in seconds) a policy report will be stored.
- Restrict
Target boolNetwork - 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 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.
- Service
History float64Max Age - Maximum age of service information to maintain, in seconds.
- Service
History float64Max Count - Maximum number of historical service information records to maintain.
- Source
Network SynciqGlobal Settings Source Network Args - Restricts replication policies on the local cluster to running on the specified subnet and pool.
- Use
Workers boolPer Node - If enabled, SyncIQ will use the deprecated workerspernode field with worker pools functionality and limit workers accordingly.
- bandwidth
Reservation DoubleReserve Absolute - 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 DoubleReserve Percentage - The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.
- cluster
Certificate StringId - The ID of this cluster's certificate being used for encryption.
- encryption
Cipher StringList - 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 Boolean - If true, requires all SyncIQ policies to utilize encrypted communications.
- force
Interface 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.
- ocsp
Address String - The address of the OCSP responder to which to connect.
- ocsp
Issuer StringCertificate Id - The ID of the certificate authority that issued the certificate whose revocation status is being checked.
- preferred
Rpo DoubleAlert - If specified, display as default RPO Alert value for new policy creation via WebUI.
- renegotiation
Period Double - If specified, the duration to persist encrypted connection before forcing a renegotiation.
- report
Emails List<String> - Email sync reports to these addresses.
- report
Max DoubleAge - ID of the Cluster Email Settings.
- report
Max DoubleCount - The default length of time (in seconds) a policy report will be stored.
- restrict
Target BooleanNetwork - 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 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.
- service
History DoubleMax Age - Maximum age of service information to maintain, in seconds.
- service
History DoubleMax Count - Maximum number of historical service information records to maintain.
- source
Network SynciqGlobal Settings Source Network - Restricts replication policies on the local cluster to running on the specified subnet and pool.
- use
Workers BooleanPer Node - If enabled, SyncIQ will use the deprecated workerspernode field with worker pools functionality and limit workers accordingly.
- bandwidth
Reservation numberReserve Absolute - 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 numberReserve Percentage - The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.
- cluster
Certificate stringId - The ID of this cluster's certificate being used for encryption.
- encryption
Cipher stringList - 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 boolean - If true, requires all SyncIQ policies to utilize encrypted communications.
- force
Interface 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.
- ocsp
Address string - The address of the OCSP responder to which to connect.
- ocsp
Issuer stringCertificate Id - The ID of the certificate authority that issued the certificate whose revocation status is being checked.
- preferred
Rpo numberAlert - If specified, display as default RPO Alert value for new policy creation via WebUI.
- renegotiation
Period number - If specified, the duration to persist encrypted connection before forcing a renegotiation.
- report
Emails string[] - Email sync reports to these addresses.
- report
Max numberAge - ID of the Cluster Email Settings.
- report
Max numberCount - The default length of time (in seconds) a policy report will be stored.
- restrict
Target booleanNetwork - 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 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.
- service
History numberMax Age - Maximum age of service information to maintain, in seconds.
- service
History numberMax Count - Maximum number of historical service information records to maintain.
- source
Network SynciqGlobal Settings Source Network - Restricts replication policies on the local cluster to running on the specified subnet and pool.
- use
Workers booleanPer Node - If enabled, SyncIQ will use the deprecated workerspernode field with worker pools functionality and limit workers accordingly.
- bandwidth_
reservation_ floatreserve_ absolute - 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_ floatreserve_ percentage - The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.
- cluster_
certificate_ strid - The ID of this cluster's certificate being used for encryption.
- encryption_
cipher_ strlist - 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.
- ocsp_
address str - The address of the OCSP responder to which to connect.
- ocsp_
issuer_ strcertificate_ id - The ID of the certificate authority that issued the certificate whose revocation status is being checked.
- preferred_
rpo_ floatalert - 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_ floatage - ID of the Cluster Email Settings.
- report_
max_ floatcount - The default length of time (in seconds) a policy report will be stored.
- restrict_
target_ boolnetwork - 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_ floatmax_ age - Maximum age of service information to maintain, in seconds.
- service_
history_ floatmax_ count - Maximum number of historical service information records to maintain.
- source_
network SynciqGlobal Settings Source Network Args - Restricts replication policies on the local cluster to running on the specified subnet and pool.
- use_
workers_ boolper_ node - If enabled, SyncIQ will use the deprecated workerspernode field with worker pools functionality and limit workers accordingly.
- bandwidth
Reservation NumberReserve Absolute - 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 NumberReserve Percentage - The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.
- cluster
Certificate StringId - The ID of this cluster's certificate being used for encryption.
- encryption
Cipher StringList - 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 Boolean - If true, requires all SyncIQ policies to utilize encrypted communications.
- force
Interface 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.
- ocsp
Address String - The address of the OCSP responder to which to connect.
- ocsp
Issuer StringCertificate Id - The ID of the certificate authority that issued the certificate whose revocation status is being checked.
- preferred
Rpo NumberAlert - If specified, display as default RPO Alert value for new policy creation via WebUI.
- renegotiation
Period Number - If specified, the duration to persist encrypted connection before forcing a renegotiation.
- report
Emails List<String> - Email sync reports to these addresses.
- report
Max NumberAge - ID of the Cluster Email Settings.
- report
Max NumberCount - The default length of time (in seconds) a policy report will be stored.
- restrict
Target BooleanNetwork - 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 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.
- service
History NumberMax Age - Maximum age of service information to maintain, in seconds.
- service
History NumberMax Count - Maximum number of historical service information records to maintain.
- source
Network Property Map - Restricts replication policies on the local cluster to running on the specified subnet and pool.
- use
Workers BooleanPer Node - If enabled, SyncIQ will use the deprecated workerspernode field with worker pools functionality and limit workers accordingly.
Outputs
All input properties are implicitly available as output properties. Additionally, the SynciqGlobalSettings resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing SynciqGlobalSettings Resource
Get an existing SynciqGlobalSettings resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SynciqGlobalSettingsState, opts?: CustomResourceOptions): SynciqGlobalSettings
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
bandwidth_reservation_reserve_absolute: Optional[float] = None,
bandwidth_reservation_reserve_percentage: Optional[float] = None,
cluster_certificate_id: Optional[str] = None,
encryption_cipher_list: Optional[str] = None,
encryption_required: Optional[bool] = None,
force_interface: Optional[bool] = None,
ocsp_address: Optional[str] = None,
ocsp_issuer_certificate_id: Optional[str] = None,
preferred_rpo_alert: Optional[float] = None,
renegotiation_period: Optional[float] = None,
report_emails: Optional[Sequence[str]] = None,
report_max_age: Optional[float] = None,
report_max_count: Optional[float] = None,
restrict_target_network: Optional[bool] = None,
rpo_alerts: Optional[bool] = None,
service: Optional[str] = None,
service_history_max_age: Optional[float] = None,
service_history_max_count: Optional[float] = None,
source_network: Optional[SynciqGlobalSettingsSourceNetworkArgs] = None,
use_workers_per_node: Optional[bool] = None) -> SynciqGlobalSettings
func GetSynciqGlobalSettings(ctx *Context, name string, id IDInput, state *SynciqGlobalSettingsState, opts ...ResourceOption) (*SynciqGlobalSettings, error)
public static SynciqGlobalSettings Get(string name, Input<string> id, SynciqGlobalSettingsState? state, CustomResourceOptions? opts = null)
public static SynciqGlobalSettings get(String name, Output<String> id, SynciqGlobalSettingsState state, CustomResourceOptions options)
resources: _: type: powerscale:SynciqGlobalSettings get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Bandwidth
Reservation doubleReserve Absolute - 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 doubleReserve Percentage - The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.
- Cluster
Certificate stringId - The ID of this cluster's certificate being used for encryption.
- Encryption
Cipher stringList - 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.
- Ocsp
Address string - The address of the OCSP responder to which to connect.
- Ocsp
Issuer stringCertificate Id - The ID of the certificate authority that issued the certificate whose revocation status is being checked.
- Preferred
Rpo doubleAlert - If specified, display as default RPO Alert value for new policy creation via WebUI.
- Renegotiation
Period double - If specified, the duration to persist encrypted connection before forcing a renegotiation.
- Report
Emails List<string> - Email sync reports to these addresses.
- Report
Max doubleAge - ID of the Cluster Email Settings.
- Report
Max doubleCount - The default length of time (in seconds) a policy report will be stored.
- Restrict
Target boolNetwork - 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 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.
- Service
History doubleMax Age - Maximum age of service information to maintain, in seconds.
- Service
History doubleMax Count - Maximum number of historical service information records to maintain.
- Source
Network SynciqGlobal Settings Source Network - Restricts replication policies on the local cluster to running on the specified subnet and pool.
- Use
Workers boolPer Node - If enabled, SyncIQ will use the deprecated workerspernode field with worker pools functionality and limit workers accordingly.
- Bandwidth
Reservation float64Reserve Absolute - 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 float64Reserve Percentage - The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.
- Cluster
Certificate stringId - The ID of this cluster's certificate being used for encryption.
- Encryption
Cipher stringList - 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.
- Ocsp
Address string - The address of the OCSP responder to which to connect.
- Ocsp
Issuer stringCertificate Id - The ID of the certificate authority that issued the certificate whose revocation status is being checked.
- Preferred
Rpo float64Alert - If specified, display as default RPO Alert value for new policy creation via WebUI.
- Renegotiation
Period float64 - If specified, the duration to persist encrypted connection before forcing a renegotiation.
- Report
Emails []string - Email sync reports to these addresses.
- Report
Max float64Age - ID of the Cluster Email Settings.
- Report
Max float64Count - The default length of time (in seconds) a policy report will be stored.
- Restrict
Target boolNetwork - 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 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.
- Service
History float64Max Age - Maximum age of service information to maintain, in seconds.
- Service
History float64Max Count - Maximum number of historical service information records to maintain.
- Source
Network SynciqGlobal Settings Source Network Args - Restricts replication policies on the local cluster to running on the specified subnet and pool.
- Use
Workers boolPer Node - If enabled, SyncIQ will use the deprecated workerspernode field with worker pools functionality and limit workers accordingly.
- bandwidth
Reservation DoubleReserve Absolute - 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 DoubleReserve Percentage - The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.
- cluster
Certificate StringId - The ID of this cluster's certificate being used for encryption.
- encryption
Cipher StringList - 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 Boolean - If true, requires all SyncIQ policies to utilize encrypted communications.
- force
Interface 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.
- ocsp
Address String - The address of the OCSP responder to which to connect.
- ocsp
Issuer StringCertificate Id - The ID of the certificate authority that issued the certificate whose revocation status is being checked.
- preferred
Rpo DoubleAlert - If specified, display as default RPO Alert value for new policy creation via WebUI.
- renegotiation
Period Double - If specified, the duration to persist encrypted connection before forcing a renegotiation.
- report
Emails List<String> - Email sync reports to these addresses.
- report
Max DoubleAge - ID of the Cluster Email Settings.
- report
Max DoubleCount - The default length of time (in seconds) a policy report will be stored.
- restrict
Target BooleanNetwork - 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 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.
- service
History DoubleMax Age - Maximum age of service information to maintain, in seconds.
- service
History DoubleMax Count - Maximum number of historical service information records to maintain.
- source
Network SynciqGlobal Settings Source Network - Restricts replication policies on the local cluster to running on the specified subnet and pool.
- use
Workers BooleanPer Node - If enabled, SyncIQ will use the deprecated workerspernode field with worker pools functionality and limit workers accordingly.
- bandwidth
Reservation numberReserve Absolute - 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 numberReserve Percentage - The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.
- cluster
Certificate stringId - The ID of this cluster's certificate being used for encryption.
- encryption
Cipher stringList - 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 boolean - If true, requires all SyncIQ policies to utilize encrypted communications.
- force
Interface 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.
- ocsp
Address string - The address of the OCSP responder to which to connect.
- ocsp
Issuer stringCertificate Id - The ID of the certificate authority that issued the certificate whose revocation status is being checked.
- preferred
Rpo numberAlert - If specified, display as default RPO Alert value for new policy creation via WebUI.
- renegotiation
Period number - If specified, the duration to persist encrypted connection before forcing a renegotiation.
- report
Emails string[] - Email sync reports to these addresses.
- report
Max numberAge - ID of the Cluster Email Settings.
- report
Max numberCount - The default length of time (in seconds) a policy report will be stored.
- restrict
Target booleanNetwork - 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 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.
- service
History numberMax Age - Maximum age of service information to maintain, in seconds.
- service
History numberMax Count - Maximum number of historical service information records to maintain.
- source
Network SynciqGlobal Settings Source Network - Restricts replication policies on the local cluster to running on the specified subnet and pool.
- use
Workers booleanPer Node - If enabled, SyncIQ will use the deprecated workerspernode field with worker pools functionality and limit workers accordingly.
- bandwidth_
reservation_ floatreserve_ absolute - 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_ floatreserve_ percentage - The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.
- cluster_
certificate_ strid - The ID of this cluster's certificate being used for encryption.
- encryption_
cipher_ strlist - 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.
- ocsp_
address str - The address of the OCSP responder to which to connect.
- ocsp_
issuer_ strcertificate_ id - The ID of the certificate authority that issued the certificate whose revocation status is being checked.
- preferred_
rpo_ floatalert - 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_ floatage - ID of the Cluster Email Settings.
- report_
max_ floatcount - The default length of time (in seconds) a policy report will be stored.
- restrict_
target_ boolnetwork - 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_ floatmax_ age - Maximum age of service information to maintain, in seconds.
- service_
history_ floatmax_ count - Maximum number of historical service information records to maintain.
- source_
network SynciqGlobal Settings Source Network Args - Restricts replication policies on the local cluster to running on the specified subnet and pool.
- use_
workers_ boolper_ node - If enabled, SyncIQ will use the deprecated workerspernode field with worker pools functionality and limit workers accordingly.
- bandwidth
Reservation NumberReserve Absolute - 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 NumberReserve Percentage - The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.
- cluster
Certificate StringId - The ID of this cluster's certificate being used for encryption.
- encryption
Cipher StringList - 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 Boolean - If true, requires all SyncIQ policies to utilize encrypted communications.
- force
Interface 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.
- ocsp
Address String - The address of the OCSP responder to which to connect.
- ocsp
Issuer StringCertificate Id - The ID of the certificate authority that issued the certificate whose revocation status is being checked.
- preferred
Rpo NumberAlert - If specified, display as default RPO Alert value for new policy creation via WebUI.
- renegotiation
Period Number - If specified, the duration to persist encrypted connection before forcing a renegotiation.
- report
Emails List<String> - Email sync reports to these addresses.
- report
Max NumberAge - ID of the Cluster Email Settings.
- report
Max NumberCount - The default length of time (in seconds) a policy report will be stored.
- restrict
Target BooleanNetwork - 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 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.
- service
History NumberMax Age - Maximum age of service information to maintain, in seconds.
- service
History NumberMax Count - Maximum number of historical service information records to maintain.
- source
Network Property Map - Restricts replication policies on the local cluster to running on the specified subnet and pool.
- use
Workers BooleanPer Node - If enabled, SyncIQ will use the deprecated workerspernode field with worker pools functionality and limit workers accordingly.
Supporting Types
SynciqGlobalSettingsSourceNetwork, SynciqGlobalSettingsSourceNetworkArgs
Import
Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
Licensed under the Mozilla Public License Version 2.0 (the “License”);
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://mozilla.org/MPL/2.0/
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an “AS IS” BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
The command is
$ pulumi import powerscale:index/synciqGlobalSettings:SynciqGlobalSettings settings <anystring>
Example:
$ pulumi import powerscale:index/synciqGlobalSettings:SynciqGlobalSettings settings global_setting
after running this command, populate one or more parameters in the config file to start managing this resource.
Note: running “terraform show” after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- powerscale dell/terraform-provider-powerscale
- License
- Notes
- This Pulumi package is based on the
powerscale
Terraform Provider.