powerscale 1.7.1, Apr 30 25

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

powerscale.SynciqPolicy

Explore with Pulumi AI

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

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.powerscale.SynciqPeerCertificate;
import com.pulumi.powerscale.SynciqPeerCertificateArgs;
import com.pulumi.powerscale.SynciqPolicy;
import com.pulumi.powerscale.SynciqPolicyArgs;
import com.pulumi.powerscale.inputs.SynciqPolicyFileMatchingPatternArgs;
import com.pulumi.powerscale.inputs.SynciqPolicySourceNetworkArgs;
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) {
        //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.
        // Available actions: Create, Update, Delete and Import.
        // For more information, Please check the terraform state file.
        var cert10101010 = new SynciqPeerCertificate("cert10101010", SynciqPeerCertificateArgs.builder()
            .path("/ifs/peerCert_10_10_10_10.pem")
            .description("Certificate for the replication peer cluster 10.10.10.10")
            .build());

        // PowerScale Sync IQ Policies can be used to replicate files or directories from one cluster to another. 
        var policy = new SynciqPolicy("policy", SynciqPolicyArgs.builder()
            .action("sync")
            .sourceRootPath("/ifs")
            .targetHost("10.10.10.10")
            .targetPath("/ifs/policy1Sink")
            .description("Policy 1 description")
            .enabled(true)
            .fileMatchingPattern(SynciqPolicyFileMatchingPatternArgs.builder()
                .or_criteria(                
                    %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
                    %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .build())
            .sourceNetwork(SynciqPolicySourceNetworkArgs.builder()
                .pool("pool0")
                .subnet("subnet0")
                .build())
            .acceleratedFailback(false)
            .bandwidthReservation(100)
            .changelist(false)
            .checkIntegrity(true)
            .cloudDeepCopy("allow")
            .deleteQuotas(true)
            .disableQuotaTmpDir(true)
            .enableHashTmpdir(true)
            .encryptionCipherList("aes128-ctr,aes192-ctr,aes256-ctr")
            .ignoreRecursiveQuota(true)
            .logLevel("fatal")
            .priority(1)
            .reportMaxAge(3600)
            .reportMaxCount(100)
            .rpoAlert(10)
            .schedule("Every Monday at 2AM")
            .skipWhenSourceUnmodified(true)
            .snapshotSyncExisting(true)
            .snapshotSyncPattern("*")
            .sourceExcludeDirectories("/ifs/SourceExcludeDir")
            .sourceIncludeDirectories("/ifs/SourceIncludeDir")
            .sourceSnapshotArchive(true)
            .sourceSnapshotExpiration(8 * 60 * 60 * 24)
            .sourceSnapshotPattern(".*")
            .syncExistingSnapshotExpiration(true)
            .syncExistingTargetSnapshotPattern("%{SnapName}-%{SnapCreateTime}")
            .targetCertificateId(cert10101010.id())
            .targetCompareInitialSync(true)
            .targetDetectModifications(true)
            .targetSnapshotAlias("SIQ-%{SrcCluster}-%{PolicyName}-latest")
            .targetSnapshotArchive(true)
            .targetSnapshotExpiration(80 * 60 * 60 * 24)
            .targetSnapshotPattern("SIQ-%{SrcCluster}-%{PolicyName}-%Y-%m-%d_%H-%M-%S")
            .build());

        // After the execution of above resource block, a Sync IQ Policy would have been cached in terraform state file
        // and a Sync IQ Policies would have been created/updated on PowerScale.
        // For more information, Please check the terraform state file.
        // sheduling a policy when source is modified
        var policyWhenSourceModified = new SynciqPolicy("policyWhenSourceModified", SynciqPolicyArgs.builder()
            .enabled(true)
            .action("sync")
            .sourceRootPath("/ifs/Source")
            .targetHost("10.10.10.9")
            .password("W0ulntUWannaKn0w")
            .targetPath("/ifs/Sink2")
            .schedule("when-source-modified")
            .jobDelay(20 * 60 * 60)
            .ocspAddress("10.20.10.9")
            .ocspIssuerCertificateId("16af57a9f676b0ab126095aa5ebadef22ab31119d644ac95cd4b93dbf3f26aeb")
            .build());

    }
}

Coming soon!

Create SynciqPolicy Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SynciqPolicy(name: string, args: SynciqPolicyArgs, opts?: CustomResourceOptions);

@overload
def SynciqPolicy(resource_name: str,
                 args: SynciqPolicyArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def SynciqPolicy(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 action: Optional[str] = None,
                 source_root_path: Optional[str] = None,
                 target_host: Optional[str] = None,
                 target_path: Optional[str] = None,
                 accelerated_failback: Optional[bool] = None,
                 allow_copy_fb: Optional[bool] = None,
                 bandwidth_reservation: Optional[float] = None,
                 changelist: Optional[bool] = None,
                 check_integrity: Optional[bool] = None,
                 cloud_deep_copy: Optional[str] = None,
                 conflicted: Optional[bool] = None,
                 delete_quotas: Optional[bool] = None,
                 description: Optional[str] = None,
                 disable_file_split: Optional[bool] = None,
                 disable_fofb: Optional[bool] = None,
                 disable_quota_tmp_dir: Optional[bool] = None,
                 disable_stf: Optional[bool] = None,
                 enable_hash_tmpdir: Optional[bool] = None,
                 enabled: Optional[bool] = None,
                 encryption_cipher_list: Optional[str] = None,
                 expected_dataloss: Optional[bool] = None,
                 file_matching_pattern: Optional[SynciqPolicyFileMatchingPatternArgs] = None,
                 force_interface: Optional[bool] = None,
                 ignore_recursive_quota: Optional[bool] = None,
                 job_delay: Optional[float] = None,
                 log_level: Optional[str] = None,
                 log_removed_files: Optional[bool] = None,
                 name: Optional[str] = None,
                 ocsp_address: Optional[str] = None,
                 ocsp_issuer_certificate_id: Optional[str] = None,
                 password: Optional[str] = None,
                 priority: Optional[float] = None,
                 report_max_age: Optional[float] = None,
                 report_max_count: Optional[float] = None,
                 restrict_target_network: Optional[bool] = None,
                 rpo_alert: Optional[float] = None,
                 schedule: Optional[str] = None,
                 skip_lookup: Optional[bool] = None,
                 skip_when_source_unmodified: Optional[bool] = None,
                 snapshot_sync_existing: Optional[bool] = None,
                 snapshot_sync_pattern: Optional[str] = None,
                 source_exclude_directories: Optional[Sequence[str]] = None,
                 source_include_directories: Optional[Sequence[str]] = None,
                 source_network: Optional[SynciqPolicySourceNetworkArgs] = None,
                 source_snapshot_archive: Optional[bool] = None,
                 source_snapshot_expiration: Optional[float] = None,
                 source_snapshot_pattern: Optional[str] = None,
                 sync_existing_snapshot_expiration: Optional[bool] = None,
                 sync_existing_target_snapshot_pattern: Optional[str] = None,
                 target_certificate_id: Optional[str] = None,
                 target_compare_initial_sync: Optional[bool] = None,
                 target_detect_modifications: Optional[bool] = None,
                 target_snapshot_alias: Optional[str] = None,
                 target_snapshot_archive: Optional[bool] = None,
                 target_snapshot_expiration: Optional[float] = None,
                 target_snapshot_pattern: Optional[str] = None,
                 workers_per_node: Optional[float] = None)

func NewSynciqPolicy(ctx *Context, name string, args SynciqPolicyArgs, opts ...ResourceOption) (*SynciqPolicy, error)

public SynciqPolicy(string name, SynciqPolicyArgs args, CustomResourceOptions? opts = null)

public SynciqPolicy(String name, SynciqPolicyArgs args)
public SynciqPolicy(String name, SynciqPolicyArgs args, CustomResourceOptions options)

type: powerscale:SynciqPolicy
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 SynciqPolicyArgs: 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 SynciqPolicyArgs: 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 SynciqPolicyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SynciqPolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SynciqPolicyArgs: 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 synciqPolicyResource = new Powerscale.SynciqPolicy("synciqPolicyResource", new()
{
    Action = "string",
    SourceRootPath = "string",
    TargetHost = "string",
    TargetPath = "string",
    AcceleratedFailback = false,
    AllowCopyFb = false,
    BandwidthReservation = 0,
    Changelist = false,
    CheckIntegrity = false,
    CloudDeepCopy = "string",
    Conflicted = false,
    DeleteQuotas = false,
    Description = "string",
    DisableFileSplit = false,
    DisableFofb = false,
    DisableQuotaTmpDir = false,
    DisableStf = false,
    EnableHashTmpdir = false,
    Enabled = false,
    EncryptionCipherList = "string",
    ExpectedDataloss = false,
    FileMatchingPattern = new Powerscale.Inputs.SynciqPolicyFileMatchingPatternArgs
    {
        OrCriterias = new[]
        {
            new Powerscale.Inputs.SynciqPolicyFileMatchingPatternOrCriteriaArgs
            {
                AndCriterias = new[]
                {
                    new Powerscale.Inputs.SynciqPolicyFileMatchingPatternOrCriteriaAndCriteriaArgs
                    {
                        AttributeExists = false,
                        CaseSensitive = false,
                        Field = "string",
                        Operator = "string",
                        Type = "string",
                        Value = "string",
                        WholeWord = false,
                    },
                },
            },
        },
    },
    ForceInterface = false,
    IgnoreRecursiveQuota = false,
    JobDelay = 0,
    LogLevel = "string",
    LogRemovedFiles = false,
    Name = "string",
    OcspAddress = "string",
    OcspIssuerCertificateId = "string",
    Password = "string",
    Priority = 0,
    ReportMaxAge = 0,
    ReportMaxCount = 0,
    RestrictTargetNetwork = false,
    RpoAlert = 0,
    Schedule = "string",
    SkipLookup = false,
    SkipWhenSourceUnmodified = false,
    SnapshotSyncExisting = false,
    SnapshotSyncPattern = "string",
    SourceExcludeDirectories = new[]
    {
        "string",
    },
    SourceIncludeDirectories = new[]
    {
        "string",
    },
    SourceNetwork = new Powerscale.Inputs.SynciqPolicySourceNetworkArgs
    {
        Pool = "string",
        Subnet = "string",
    },
    SourceSnapshotArchive = false,
    SourceSnapshotExpiration = 0,
    SourceSnapshotPattern = "string",
    SyncExistingSnapshotExpiration = false,
    SyncExistingTargetSnapshotPattern = "string",
    TargetCertificateId = "string",
    TargetCompareInitialSync = false,
    TargetDetectModifications = false,
    TargetSnapshotAlias = "string",
    TargetSnapshotArchive = false,
    TargetSnapshotExpiration = 0,
    TargetSnapshotPattern = "string",
    WorkersPerNode = 0,
});

example, err := powerscale.NewSynciqPolicy(ctx, "synciqPolicyResource", &powerscale.SynciqPolicyArgs{
	Action:               pulumi.String("string"),
	SourceRootPath:       pulumi.String("string"),
	TargetHost:           pulumi.String("string"),
	TargetPath:           pulumi.String("string"),
	AcceleratedFailback:  pulumi.Bool(false),
	AllowCopyFb:          pulumi.Bool(false),
	BandwidthReservation: pulumi.Float64(0),
	Changelist:           pulumi.Bool(false),
	CheckIntegrity:       pulumi.Bool(false),
	CloudDeepCopy:        pulumi.String("string"),
	Conflicted:           pulumi.Bool(false),
	DeleteQuotas:         pulumi.Bool(false),
	Description:          pulumi.String("string"),
	DisableFileSplit:     pulumi.Bool(false),
	DisableFofb:          pulumi.Bool(false),
	DisableQuotaTmpDir:   pulumi.Bool(false),
	DisableStf:           pulumi.Bool(false),
	EnableHashTmpdir:     pulumi.Bool(false),
	Enabled:              pulumi.Bool(false),
	EncryptionCipherList: pulumi.String("string"),
	ExpectedDataloss:     pulumi.Bool(false),
	FileMatchingPattern: &powerscale.SynciqPolicyFileMatchingPatternArgs{
		OrCriterias: powerscale.SynciqPolicyFileMatchingPatternOrCriteriaArray{
			&powerscale.SynciqPolicyFileMatchingPatternOrCriteriaArgs{
				AndCriterias: powerscale.SynciqPolicyFileMatchingPatternOrCriteriaAndCriteriaArray{
					&powerscale.SynciqPolicyFileMatchingPatternOrCriteriaAndCriteriaArgs{
						AttributeExists: pulumi.Bool(false),
						CaseSensitive:   pulumi.Bool(false),
						Field:           pulumi.String("string"),
						Operator:        pulumi.String("string"),
						Type:            pulumi.String("string"),
						Value:           pulumi.String("string"),
						WholeWord:       pulumi.Bool(false),
					},
				},
			},
		},
	},
	ForceInterface:           pulumi.Bool(false),
	IgnoreRecursiveQuota:     pulumi.Bool(false),
	JobDelay:                 pulumi.Float64(0),
	LogLevel:                 pulumi.String("string"),
	LogRemovedFiles:          pulumi.Bool(false),
	Name:                     pulumi.String("string"),
	OcspAddress:              pulumi.String("string"),
	OcspIssuerCertificateId:  pulumi.String("string"),
	Password:                 pulumi.String("string"),
	Priority:                 pulumi.Float64(0),
	ReportMaxAge:             pulumi.Float64(0),
	ReportMaxCount:           pulumi.Float64(0),
	RestrictTargetNetwork:    pulumi.Bool(false),
	RpoAlert:                 pulumi.Float64(0),
	Schedule:                 pulumi.String("string"),
	SkipLookup:               pulumi.Bool(false),
	SkipWhenSourceUnmodified: pulumi.Bool(false),
	SnapshotSyncExisting:     pulumi.Bool(false),
	SnapshotSyncPattern:      pulumi.String("string"),
	SourceExcludeDirectories: pulumi.StringArray{
		pulumi.String("string"),
	},
	SourceIncludeDirectories: pulumi.StringArray{
		pulumi.String("string"),
	},
	SourceNetwork: &powerscale.SynciqPolicySourceNetworkArgs{
		Pool:   pulumi.String("string"),
		Subnet: pulumi.String("string"),
	},
	SourceSnapshotArchive:             pulumi.Bool(false),
	SourceSnapshotExpiration:          pulumi.Float64(0),
	SourceSnapshotPattern:             pulumi.String("string"),
	SyncExistingSnapshotExpiration:    pulumi.Bool(false),
	SyncExistingTargetSnapshotPattern: pulumi.String("string"),
	TargetCertificateId:               pulumi.String("string"),
	TargetCompareInitialSync:          pulumi.Bool(false),
	TargetDetectModifications:         pulumi.Bool(false),
	TargetSnapshotAlias:               pulumi.String("string"),
	TargetSnapshotArchive:             pulumi.Bool(false),
	TargetSnapshotExpiration:          pulumi.Float64(0),
	TargetSnapshotPattern:             pulumi.String("string"),
	WorkersPerNode:                    pulumi.Float64(0),
})

var synciqPolicyResource = new SynciqPolicy("synciqPolicyResource", SynciqPolicyArgs.builder()
    .action("string")
    .sourceRootPath("string")
    .targetHost("string")
    .targetPath("string")
    .acceleratedFailback(false)
    .allowCopyFb(false)
    .bandwidthReservation(0)
    .changelist(false)
    .checkIntegrity(false)
    .cloudDeepCopy("string")
    .conflicted(false)
    .deleteQuotas(false)
    .description("string")
    .disableFileSplit(false)
    .disableFofb(false)
    .disableQuotaTmpDir(false)
    .disableStf(false)
    .enableHashTmpdir(false)
    .enabled(false)
    .encryptionCipherList("string")
    .expectedDataloss(false)
    .fileMatchingPattern(SynciqPolicyFileMatchingPatternArgs.builder()
        .orCriterias(SynciqPolicyFileMatchingPatternOrCriteriaArgs.builder()
            .andCriterias(SynciqPolicyFileMatchingPatternOrCriteriaAndCriteriaArgs.builder()
                .attributeExists(false)
                .caseSensitive(false)
                .field("string")
                .operator("string")
                .type("string")
                .value("string")
                .wholeWord(false)
                .build())
            .build())
        .build())
    .forceInterface(false)
    .ignoreRecursiveQuota(false)
    .jobDelay(0)
    .logLevel("string")
    .logRemovedFiles(false)
    .name("string")
    .ocspAddress("string")
    .ocspIssuerCertificateId("string")
    .password("string")
    .priority(0)
    .reportMaxAge(0)
    .reportMaxCount(0)
    .restrictTargetNetwork(false)
    .rpoAlert(0)
    .schedule("string")
    .skipLookup(false)
    .skipWhenSourceUnmodified(false)
    .snapshotSyncExisting(false)
    .snapshotSyncPattern("string")
    .sourceExcludeDirectories("string")
    .sourceIncludeDirectories("string")
    .sourceNetwork(SynciqPolicySourceNetworkArgs.builder()
        .pool("string")
        .subnet("string")
        .build())
    .sourceSnapshotArchive(false)
    .sourceSnapshotExpiration(0)
    .sourceSnapshotPattern("string")
    .syncExistingSnapshotExpiration(false)
    .syncExistingTargetSnapshotPattern("string")
    .targetCertificateId("string")
    .targetCompareInitialSync(false)
    .targetDetectModifications(false)
    .targetSnapshotAlias("string")
    .targetSnapshotArchive(false)
    .targetSnapshotExpiration(0)
    .targetSnapshotPattern("string")
    .workersPerNode(0)
    .build());

synciq_policy_resource = powerscale.SynciqPolicy("synciqPolicyResource",
    action="string",
    source_root_path="string",
    target_host="string",
    target_path="string",
    accelerated_failback=False,
    allow_copy_fb=False,
    bandwidth_reservation=0,
    changelist=False,
    check_integrity=False,
    cloud_deep_copy="string",
    conflicted=False,
    delete_quotas=False,
    description="string",
    disable_file_split=False,
    disable_fofb=False,
    disable_quota_tmp_dir=False,
    disable_stf=False,
    enable_hash_tmpdir=False,
    enabled=False,
    encryption_cipher_list="string",
    expected_dataloss=False,
    file_matching_pattern={
        "or_criterias": [{
            "and_criterias": [{
                "attribute_exists": False,
                "case_sensitive": False,
                "field": "string",
                "operator": "string",
                "type": "string",
                "value": "string",
                "whole_word": False,
            }],
        }],
    },
    force_interface=False,
    ignore_recursive_quota=False,
    job_delay=0,
    log_level="string",
    log_removed_files=False,
    name="string",
    ocsp_address="string",
    ocsp_issuer_certificate_id="string",
    password="string",
    priority=0,
    report_max_age=0,
    report_max_count=0,
    restrict_target_network=False,
    rpo_alert=0,
    schedule="string",
    skip_lookup=False,
    skip_when_source_unmodified=False,
    snapshot_sync_existing=False,
    snapshot_sync_pattern="string",
    source_exclude_directories=["string"],
    source_include_directories=["string"],
    source_network={
        "pool": "string",
        "subnet": "string",
    },
    source_snapshot_archive=False,
    source_snapshot_expiration=0,
    source_snapshot_pattern="string",
    sync_existing_snapshot_expiration=False,
    sync_existing_target_snapshot_pattern="string",
    target_certificate_id="string",
    target_compare_initial_sync=False,
    target_detect_modifications=False,
    target_snapshot_alias="string",
    target_snapshot_archive=False,
    target_snapshot_expiration=0,
    target_snapshot_pattern="string",
    workers_per_node=0)

const synciqPolicyResource = new powerscale.SynciqPolicy("synciqPolicyResource", {
    action: "string",
    sourceRootPath: "string",
    targetHost: "string",
    targetPath: "string",
    acceleratedFailback: false,
    allowCopyFb: false,
    bandwidthReservation: 0,
    changelist: false,
    checkIntegrity: false,
    cloudDeepCopy: "string",
    conflicted: false,
    deleteQuotas: false,
    description: "string",
    disableFileSplit: false,
    disableFofb: false,
    disableQuotaTmpDir: false,
    disableStf: false,
    enableHashTmpdir: false,
    enabled: false,
    encryptionCipherList: "string",
    expectedDataloss: false,
    fileMatchingPattern: {
        orCriterias: [{
            andCriterias: [{
                attributeExists: false,
                caseSensitive: false,
                field: "string",
                operator: "string",
                type: "string",
                value: "string",
                wholeWord: false,
            }],
        }],
    },
    forceInterface: false,
    ignoreRecursiveQuota: false,
    jobDelay: 0,
    logLevel: "string",
    logRemovedFiles: false,
    name: "string",
    ocspAddress: "string",
    ocspIssuerCertificateId: "string",
    password: "string",
    priority: 0,
    reportMaxAge: 0,
    reportMaxCount: 0,
    restrictTargetNetwork: false,
    rpoAlert: 0,
    schedule: "string",
    skipLookup: false,
    skipWhenSourceUnmodified: false,
    snapshotSyncExisting: false,
    snapshotSyncPattern: "string",
    sourceExcludeDirectories: ["string"],
    sourceIncludeDirectories: ["string"],
    sourceNetwork: {
        pool: "string",
        subnet: "string",
    },
    sourceSnapshotArchive: false,
    sourceSnapshotExpiration: 0,
    sourceSnapshotPattern: "string",
    syncExistingSnapshotExpiration: false,
    syncExistingTargetSnapshotPattern: "string",
    targetCertificateId: "string",
    targetCompareInitialSync: false,
    targetDetectModifications: false,
    targetSnapshotAlias: "string",
    targetSnapshotArchive: false,
    targetSnapshotExpiration: 0,
    targetSnapshotPattern: "string",
    workersPerNode: 0,
});

type: powerscale:SynciqPolicy
properties:
    acceleratedFailback: false
    action: string
    allowCopyFb: false
    bandwidthReservation: 0
    changelist: false
    checkIntegrity: false
    cloudDeepCopy: string
    conflicted: false
    deleteQuotas: false
    description: string
    disableFileSplit: false
    disableFofb: false
    disableQuotaTmpDir: false
    disableStf: false
    enableHashTmpdir: false
    enabled: false
    encryptionCipherList: string
    expectedDataloss: false
    fileMatchingPattern:
        orCriterias:
            - andCriterias:
                - attributeExists: false
                  caseSensitive: false
                  field: string
                  operator: string
                  type: string
                  value: string
                  wholeWord: false
    forceInterface: false
    ignoreRecursiveQuota: false
    jobDelay: 0
    logLevel: string
    logRemovedFiles: false
    name: string
    ocspAddress: string
    ocspIssuerCertificateId: string
    password: string
    priority: 0
    reportMaxAge: 0
    reportMaxCount: 0
    restrictTargetNetwork: false
    rpoAlert: 0
    schedule: string
    skipLookup: false
    skipWhenSourceUnmodified: false
    snapshotSyncExisting: false
    snapshotSyncPattern: string
    sourceExcludeDirectories:
        - string
    sourceIncludeDirectories:
        - string
    sourceNetwork:
        pool: string
        subnet: string
    sourceRootPath: string
    sourceSnapshotArchive: false
    sourceSnapshotExpiration: 0
    sourceSnapshotPattern: string
    syncExistingSnapshotExpiration: false
    syncExistingTargetSnapshotPattern: string
    targetCertificateId: string
    targetCompareInitialSync: false
    targetDetectModifications: false
    targetHost: string
    targetPath: string
    targetSnapshotAlias: string
    targetSnapshotArchive: false
    targetSnapshotExpiration: 0
    targetSnapshotPattern: string
    workersPerNode: 0

SynciqPolicy 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 SynciqPolicy resource accepts the following input properties:

Action string: If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.
SourceRootPath string: The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.
TargetHost string: Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.
TargetPath string: Absolute filesystem path on the target cluster for the sync destination.
AcceleratedFailback bool: If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.
AllowCopyFb bool: If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.
BandwidthReservation double: The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.
Changelist bool: If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.
CheckIntegrity bool: If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.
CloudDeepCopy string: If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.
Conflicted bool: NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.
DeleteQuotas bool: If true, forcibly remove quotas on the target after they have been removed on the source.
Description string: User-assigned description of this sync policy.
DisableFileSplit bool: NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.
DisableFofb bool: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.
DisableQuotaTmpDir bool: If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.
DisableStf bool: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.
EnableHashTmpdir bool: If true, syncs will use temporary working directory subdirectories to reduce lock contention.
Enabled bool: If true, jobs will be automatically run based on this policy, according to its schedule.
EncryptionCipherList string: The cipher list (comma separated) 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.
ExpectedDataloss bool: NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.
FileMatchingPattern SynciqPolicyFileMatchingPattern: A file matching pattern, organized as an OR'ed set of AND'ed file criteria, for example ((a AND b) OR (x AND y)) used to define a set of files with specific properties. Policies of type 'sync' cannot use 'path' or time criteria in their matching patterns, but policies of type 'copy' can use all listed criteria.
ForceInterface bool: NOTE: This field should not be changed without the help of PowerScale support. 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. If you enable this option, the net.inet.ip.chooseifabyipsrc sysctl should be set.
IgnoreRecursiveQuota bool: If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.
JobDelay double: If schedule is set to when-source-modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).
LogLevel string: Severity an event must reach before it is logged. Accepted values are fatal, error, notice, info, copy, debug, trace.
LogRemovedFiles bool: If true, the system will log any files or directories that are deleted due to a sync.
Name string: User-assigned name of this sync policy.
OcspAddress string: The address of the OCSP responder to which to connect. Set to empty string to disable OCSP.
OcspIssuerCertificateId string: The ID of the certificate authority that issued the certificate whose revocation status is being checked. Set to empty string to disable certificate verification.
Password string: The password for the target cluster. This field is not readable.
Priority double: Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.
ReportMaxAge double: Length of time (in seconds) a policy report will be stored.
ReportMaxCount double: Maximum number of policy reports that will be stored on the system.
RestrictTargetNetwork bool: 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.
RpoAlert double: If schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.
Schedule string: The schedule on which new jobs will be run for this policy.
SkipLookup bool: Skip DNS lookup of target IPs.
SkipWhenSourceUnmodified bool: If true and schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.
SnapshotSyncExisting bool: If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).
SnapshotSyncPattern string: The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is "*").
SourceExcludeDirectories List<string>: Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.
SourceIncludeDirectories List<string>: Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.
SourceNetwork SynciqPolicySourceNetwork: Restricts replication policies on the local cluster to running on the specified subnet and pool.
SourceSnapshotArchive bool: If true, archival snapshots of the source data will be taken on the source cluster before a sync.
SourceSnapshotExpiration double: The length of time in seconds to keep snapshots on the source cluster.
SourceSnapshotPattern string: The name pattern for snapshots taken on the source cluster before a sync.
SyncExistingSnapshotExpiration bool: If set to true, the expire duration for target archival snapshot is the remaining expire duration of source snapshot, requires --sync-existing-snapshot=true
SyncExistingTargetSnapshotPattern string: The naming pattern for snapshot on the destination cluster when --sync-existing-snapshot is true
TargetCertificateId string: The ID of the target cluster certificate being used for encryption. Set to empty string to disable target certificate verification.
TargetCompareInitialSync bool: If true, the target creates diffs against the original sync.
TargetDetectModifications bool: If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.
TargetSnapshotAlias string: The alias of the snapshot taken on the target cluster after the sync completes. Do not use the value DEFAULT.
TargetSnapshotArchive bool: If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.
TargetSnapshotExpiration double: The length of time in seconds to keep snapshots on the target cluster.
TargetSnapshotPattern string: The name pattern for snapshots taken on the target cluster after the sync completes. Do not use the value @DEFAULT.
WorkersPerNode double: The number of worker threads on a node performing a sync.

Action string: If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.
SourceRootPath string: The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.
TargetHost string: Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.
TargetPath string: Absolute filesystem path on the target cluster for the sync destination.
AcceleratedFailback bool: If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.
AllowCopyFb bool: If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.
BandwidthReservation float64: The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.
Changelist bool: If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.
CheckIntegrity bool: If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.
CloudDeepCopy string: If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.
Conflicted bool: NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.
DeleteQuotas bool: If true, forcibly remove quotas on the target after they have been removed on the source.
Description string: User-assigned description of this sync policy.
DisableFileSplit bool: NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.
DisableFofb bool: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.
DisableQuotaTmpDir bool: If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.
DisableStf bool: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.
EnableHashTmpdir bool: If true, syncs will use temporary working directory subdirectories to reduce lock contention.
Enabled bool: If true, jobs will be automatically run based on this policy, according to its schedule.
EncryptionCipherList string: The cipher list (comma separated) 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.
ExpectedDataloss bool: NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.
FileMatchingPattern SynciqPolicyFileMatchingPatternArgs: A file matching pattern, organized as an OR'ed set of AND'ed file criteria, for example ((a AND b) OR (x AND y)) used to define a set of files with specific properties. Policies of type 'sync' cannot use 'path' or time criteria in their matching patterns, but policies of type 'copy' can use all listed criteria.
ForceInterface bool: NOTE: This field should not be changed without the help of PowerScale support. 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. If you enable this option, the net.inet.ip.chooseifabyipsrc sysctl should be set.
IgnoreRecursiveQuota bool: If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.
JobDelay float64: If schedule is set to when-source-modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).
LogLevel string: Severity an event must reach before it is logged. Accepted values are fatal, error, notice, info, copy, debug, trace.
LogRemovedFiles bool: If true, the system will log any files or directories that are deleted due to a sync.
Name string: User-assigned name of this sync policy.
OcspAddress string: The address of the OCSP responder to which to connect. Set to empty string to disable OCSP.
OcspIssuerCertificateId string: The ID of the certificate authority that issued the certificate whose revocation status is being checked. Set to empty string to disable certificate verification.
Password string: The password for the target cluster. This field is not readable.
Priority float64: Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.
ReportMaxAge float64: Length of time (in seconds) a policy report will be stored.
ReportMaxCount float64: Maximum number of policy reports that will be stored on the system.
RestrictTargetNetwork bool: 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.
RpoAlert float64: If schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.
Schedule string: The schedule on which new jobs will be run for this policy.
SkipLookup bool: Skip DNS lookup of target IPs.
SkipWhenSourceUnmodified bool: If true and schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.
SnapshotSyncExisting bool: If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).
SnapshotSyncPattern string: The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is "*").
SourceExcludeDirectories []string: Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.
SourceIncludeDirectories []string: Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.
SourceNetwork SynciqPolicySourceNetworkArgs: Restricts replication policies on the local cluster to running on the specified subnet and pool.
SourceSnapshotArchive bool: If true, archival snapshots of the source data will be taken on the source cluster before a sync.
SourceSnapshotExpiration float64: The length of time in seconds to keep snapshots on the source cluster.
SourceSnapshotPattern string: The name pattern for snapshots taken on the source cluster before a sync.
SyncExistingSnapshotExpiration bool: If set to true, the expire duration for target archival snapshot is the remaining expire duration of source snapshot, requires --sync-existing-snapshot=true
SyncExistingTargetSnapshotPattern string: The naming pattern for snapshot on the destination cluster when --sync-existing-snapshot is true
TargetCertificateId string: The ID of the target cluster certificate being used for encryption. Set to empty string to disable target certificate verification.
TargetCompareInitialSync bool: If true, the target creates diffs against the original sync.
TargetDetectModifications bool: If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.
TargetSnapshotAlias string: The alias of the snapshot taken on the target cluster after the sync completes. Do not use the value DEFAULT.
TargetSnapshotArchive bool: If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.
TargetSnapshotExpiration float64: The length of time in seconds to keep snapshots on the target cluster.
TargetSnapshotPattern string: The name pattern for snapshots taken on the target cluster after the sync completes. Do not use the value @DEFAULT.
WorkersPerNode float64: The number of worker threads on a node performing a sync.

action String: If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.
sourceRootPath String: The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.
targetHost String: Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.
targetPath String: Absolute filesystem path on the target cluster for the sync destination.
acceleratedFailback Boolean: If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.
allowCopyFb Boolean: If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.
bandwidthReservation Double: The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.
changelist Boolean: If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.
checkIntegrity Boolean: If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.
cloudDeepCopy String: If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.
conflicted Boolean: NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.
deleteQuotas Boolean: If true, forcibly remove quotas on the target after they have been removed on the source.
description String: User-assigned description of this sync policy.
disableFileSplit Boolean: NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.
disableFofb Boolean: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.
disableQuotaTmpDir Boolean: If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.
disableStf Boolean: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.
enableHashTmpdir Boolean: If true, syncs will use temporary working directory subdirectories to reduce lock contention.
enabled Boolean: If true, jobs will be automatically run based on this policy, according to its schedule.
encryptionCipherList String: The cipher list (comma separated) 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.
expectedDataloss Boolean: NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.
fileMatchingPattern SynciqPolicyFileMatchingPattern: A file matching pattern, organized as an OR'ed set of AND'ed file criteria, for example ((a AND b) OR (x AND y)) used to define a set of files with specific properties. Policies of type 'sync' cannot use 'path' or time criteria in their matching patterns, but policies of type 'copy' can use all listed criteria.
forceInterface Boolean: NOTE: This field should not be changed without the help of PowerScale support. 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. If you enable this option, the net.inet.ip.chooseifabyipsrc sysctl should be set.
ignoreRecursiveQuota Boolean: If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.
jobDelay Double: If schedule is set to when-source-modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).
logLevel String: Severity an event must reach before it is logged. Accepted values are fatal, error, notice, info, copy, debug, trace.
logRemovedFiles Boolean: If true, the system will log any files or directories that are deleted due to a sync.
name String: User-assigned name of this sync policy.
ocspAddress String: The address of the OCSP responder to which to connect. Set to empty string to disable OCSP.
ocspIssuerCertificateId String: The ID of the certificate authority that issued the certificate whose revocation status is being checked. Set to empty string to disable certificate verification.
password String: The password for the target cluster. This field is not readable.
priority Double: Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.
reportMaxAge Double: Length of time (in seconds) a policy report will be stored.
reportMaxCount Double: Maximum number of policy reports that will be stored on the system.
restrictTargetNetwork Boolean: 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.
rpoAlert Double: If schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.
schedule String: The schedule on which new jobs will be run for this policy.
skipLookup Boolean: Skip DNS lookup of target IPs.
skipWhenSourceUnmodified Boolean: If true and schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.
snapshotSyncExisting Boolean: If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).
snapshotSyncPattern String: The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is "*").
sourceExcludeDirectories List<String>: Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.
sourceIncludeDirectories List<String>: Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.
sourceNetwork SynciqPolicySourceNetwork: Restricts replication policies on the local cluster to running on the specified subnet and pool.
sourceSnapshotArchive Boolean: If true, archival snapshots of the source data will be taken on the source cluster before a sync.
sourceSnapshotExpiration Double: The length of time in seconds to keep snapshots on the source cluster.
sourceSnapshotPattern String: The name pattern for snapshots taken on the source cluster before a sync.
syncExistingSnapshotExpiration Boolean: If set to true, the expire duration for target archival snapshot is the remaining expire duration of source snapshot, requires --sync-existing-snapshot=true
syncExistingTargetSnapshotPattern String: The naming pattern for snapshot on the destination cluster when --sync-existing-snapshot is true
targetCertificateId String: The ID of the target cluster certificate being used for encryption. Set to empty string to disable target certificate verification.
targetCompareInitialSync Boolean: If true, the target creates diffs against the original sync.
targetDetectModifications Boolean: If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.
targetSnapshotAlias String: The alias of the snapshot taken on the target cluster after the sync completes. Do not use the value DEFAULT.
targetSnapshotArchive Boolean: If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.
targetSnapshotExpiration Double: The length of time in seconds to keep snapshots on the target cluster.
targetSnapshotPattern String: The name pattern for snapshots taken on the target cluster after the sync completes. Do not use the value @DEFAULT.
workersPerNode Double: The number of worker threads on a node performing a sync.

action string: If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.
sourceRootPath string: The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.
targetHost string: Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.
targetPath string: Absolute filesystem path on the target cluster for the sync destination.
acceleratedFailback boolean: If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.
allowCopyFb boolean: If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.
bandwidthReservation number: The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.
changelist boolean: If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.
checkIntegrity boolean: If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.
cloudDeepCopy string: If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.
conflicted boolean: NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.
deleteQuotas boolean: If true, forcibly remove quotas on the target after they have been removed on the source.
description string: User-assigned description of this sync policy.
disableFileSplit boolean: NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.
disableFofb boolean: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.
disableQuotaTmpDir boolean: If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.
disableStf boolean: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.
enableHashTmpdir boolean: If true, syncs will use temporary working directory subdirectories to reduce lock contention.
enabled boolean: If true, jobs will be automatically run based on this policy, according to its schedule.
encryptionCipherList string: The cipher list (comma separated) 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.
expectedDataloss boolean: NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.
fileMatchingPattern SynciqPolicyFileMatchingPattern: A file matching pattern, organized as an OR'ed set of AND'ed file criteria, for example ((a AND b) OR (x AND y)) used to define a set of files with specific properties. Policies of type 'sync' cannot use 'path' or time criteria in their matching patterns, but policies of type 'copy' can use all listed criteria.
forceInterface boolean: NOTE: This field should not be changed without the help of PowerScale support. 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. If you enable this option, the net.inet.ip.chooseifabyipsrc sysctl should be set.
ignoreRecursiveQuota boolean: If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.
jobDelay number: If schedule is set to when-source-modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).
logLevel string: Severity an event must reach before it is logged. Accepted values are fatal, error, notice, info, copy, debug, trace.
logRemovedFiles boolean: If true, the system will log any files or directories that are deleted due to a sync.
name string: User-assigned name of this sync policy.
ocspAddress string: The address of the OCSP responder to which to connect. Set to empty string to disable OCSP.
ocspIssuerCertificateId string: The ID of the certificate authority that issued the certificate whose revocation status is being checked. Set to empty string to disable certificate verification.
password string: The password for the target cluster. This field is not readable.
priority number: Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.
reportMaxAge number: Length of time (in seconds) a policy report will be stored.
reportMaxCount number: Maximum number of policy reports that will be stored on the system.
restrictTargetNetwork boolean: 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.
rpoAlert number: If schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.
schedule string: The schedule on which new jobs will be run for this policy.
skipLookup boolean: Skip DNS lookup of target IPs.
skipWhenSourceUnmodified boolean: If true and schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.
snapshotSyncExisting boolean: If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).
snapshotSyncPattern string: The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is "*").
sourceExcludeDirectories string[]: Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.
sourceIncludeDirectories string[]: Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.
sourceNetwork SynciqPolicySourceNetwork: Restricts replication policies on the local cluster to running on the specified subnet and pool.
sourceSnapshotArchive boolean: If true, archival snapshots of the source data will be taken on the source cluster before a sync.
sourceSnapshotExpiration number: The length of time in seconds to keep snapshots on the source cluster.
sourceSnapshotPattern string: The name pattern for snapshots taken on the source cluster before a sync.
syncExistingSnapshotExpiration boolean: If set to true, the expire duration for target archival snapshot is the remaining expire duration of source snapshot, requires --sync-existing-snapshot=true
syncExistingTargetSnapshotPattern string: The naming pattern for snapshot on the destination cluster when --sync-existing-snapshot is true
targetCertificateId string: The ID of the target cluster certificate being used for encryption. Set to empty string to disable target certificate verification.
targetCompareInitialSync boolean: If true, the target creates diffs against the original sync.
targetDetectModifications boolean: If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.
targetSnapshotAlias string: The alias of the snapshot taken on the target cluster after the sync completes. Do not use the value DEFAULT.
targetSnapshotArchive boolean: If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.
targetSnapshotExpiration number: The length of time in seconds to keep snapshots on the target cluster.
targetSnapshotPattern string: The name pattern for snapshots taken on the target cluster after the sync completes. Do not use the value @DEFAULT.
workersPerNode number: The number of worker threads on a node performing a sync.

action str: If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.
source_root_path str: The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.
target_host str: Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.
target_path str: Absolute filesystem path on the target cluster for the sync destination.
accelerated_failback bool: If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.
allow_copy_fb bool: If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.
bandwidth_reservation float: The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.
changelist bool: If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.
check_integrity bool: If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.
cloud_deep_copy str: If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.
conflicted bool: NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.
delete_quotas bool: If true, forcibly remove quotas on the target after they have been removed on the source.
description str: User-assigned description of this sync policy.
disable_file_split bool: NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.
disable_fofb bool: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.
disable_quota_tmp_dir bool: If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.
disable_stf bool: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.
enable_hash_tmpdir bool: If true, syncs will use temporary working directory subdirectories to reduce lock contention.
enabled bool: If true, jobs will be automatically run based on this policy, according to its schedule.
encryption_cipher_list str: The cipher list (comma separated) 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.
expected_dataloss bool: NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.
file_matching_pattern SynciqPolicyFileMatchingPatternArgs: A file matching pattern, organized as an OR'ed set of AND'ed file criteria, for example ((a AND b) OR (x AND y)) used to define a set of files with specific properties. Policies of type 'sync' cannot use 'path' or time criteria in their matching patterns, but policies of type 'copy' can use all listed criteria.
force_interface bool: NOTE: This field should not be changed without the help of PowerScale support. 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. If you enable this option, the net.inet.ip.chooseifabyipsrc sysctl should be set.
ignore_recursive_quota bool: If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.
job_delay float: If schedule is set to when-source-modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).
log_level str: Severity an event must reach before it is logged. Accepted values are fatal, error, notice, info, copy, debug, trace.
log_removed_files bool: If true, the system will log any files or directories that are deleted due to a sync.
name str: User-assigned name of this sync policy.
ocsp_address str: The address of the OCSP responder to which to connect. Set to empty string to disable OCSP.
ocsp_issuer_certificate_id str: The ID of the certificate authority that issued the certificate whose revocation status is being checked. Set to empty string to disable certificate verification.
password str: The password for the target cluster. This field is not readable.
priority float: Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.
report_max_age float: Length of time (in seconds) a policy report will be stored.
report_max_count float: Maximum number of policy reports that will be stored on the system.
restrict_target_network bool: 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_alert float: If schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.
schedule str: The schedule on which new jobs will be run for this policy.
skip_lookup bool: Skip DNS lookup of target IPs.
skip_when_source_unmodified bool: If true and schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.
snapshot_sync_existing bool: If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).
snapshot_sync_pattern str: The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is "*").
source_exclude_directories Sequence[str]: Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.
source_include_directories Sequence[str]: Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.
source_network SynciqPolicySourceNetworkArgs: Restricts replication policies on the local cluster to running on the specified subnet and pool.
source_snapshot_archive bool: If true, archival snapshots of the source data will be taken on the source cluster before a sync.
source_snapshot_expiration float: The length of time in seconds to keep snapshots on the source cluster.
source_snapshot_pattern str: The name pattern for snapshots taken on the source cluster before a sync.
sync_existing_snapshot_expiration bool: If set to true, the expire duration for target archival snapshot is the remaining expire duration of source snapshot, requires --sync-existing-snapshot=true
sync_existing_target_snapshot_pattern str: The naming pattern for snapshot on the destination cluster when --sync-existing-snapshot is true
target_certificate_id str: The ID of the target cluster certificate being used for encryption. Set to empty string to disable target certificate verification.
target_compare_initial_sync bool: If true, the target creates diffs against the original sync.
target_detect_modifications bool: If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.
target_snapshot_alias str: The alias of the snapshot taken on the target cluster after the sync completes. Do not use the value DEFAULT.
target_snapshot_archive bool: If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.
target_snapshot_expiration float: The length of time in seconds to keep snapshots on the target cluster.
target_snapshot_pattern str: The name pattern for snapshots taken on the target cluster after the sync completes. Do not use the value @DEFAULT.
workers_per_node float: The number of worker threads on a node performing a sync.

action String: If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.
sourceRootPath String: The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.
targetHost String: Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.
targetPath String: Absolute filesystem path on the target cluster for the sync destination.
acceleratedFailback Boolean: If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.
allowCopyFb Boolean: If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.
bandwidthReservation Number: The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.
changelist Boolean: If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.
checkIntegrity Boolean: If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.
cloudDeepCopy String: If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.
conflicted Boolean: NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.
deleteQuotas Boolean: If true, forcibly remove quotas on the target after they have been removed on the source.
description String: User-assigned description of this sync policy.
disableFileSplit Boolean: NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.
disableFofb Boolean: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.
disableQuotaTmpDir Boolean: If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.
disableStf Boolean: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.
enableHashTmpdir Boolean: If true, syncs will use temporary working directory subdirectories to reduce lock contention.
enabled Boolean: If true, jobs will be automatically run based on this policy, according to its schedule.
encryptionCipherList String: The cipher list (comma separated) 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.
expectedDataloss Boolean: NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.
fileMatchingPattern Property Map: A file matching pattern, organized as an OR'ed set of AND'ed file criteria, for example ((a AND b) OR (x AND y)) used to define a set of files with specific properties. Policies of type 'sync' cannot use 'path' or time criteria in their matching patterns, but policies of type 'copy' can use all listed criteria.
forceInterface Boolean: NOTE: This field should not be changed without the help of PowerScale support. 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. If you enable this option, the net.inet.ip.chooseifabyipsrc sysctl should be set.
ignoreRecursiveQuota Boolean: If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.
jobDelay Number: If schedule is set to when-source-modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).
logLevel String: Severity an event must reach before it is logged. Accepted values are fatal, error, notice, info, copy, debug, trace.
logRemovedFiles Boolean: If true, the system will log any files or directories that are deleted due to a sync.
name String: User-assigned name of this sync policy.
ocspAddress String: The address of the OCSP responder to which to connect. Set to empty string to disable OCSP.
ocspIssuerCertificateId String: The ID of the certificate authority that issued the certificate whose revocation status is being checked. Set to empty string to disable certificate verification.
password String: The password for the target cluster. This field is not readable.
priority Number: Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.
reportMaxAge Number: Length of time (in seconds) a policy report will be stored.
reportMaxCount Number: Maximum number of policy reports that will be stored on the system.
restrictTargetNetwork Boolean: 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.
rpoAlert Number: If schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.
schedule String: The schedule on which new jobs will be run for this policy.
skipLookup Boolean: Skip DNS lookup of target IPs.
skipWhenSourceUnmodified Boolean: If true and schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.
snapshotSyncExisting Boolean: If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).
snapshotSyncPattern String: The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is "*").
sourceExcludeDirectories List<String>: Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.
sourceIncludeDirectories List<String>: Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.
sourceNetwork Property Map: Restricts replication policies on the local cluster to running on the specified subnet and pool.
sourceSnapshotArchive Boolean: If true, archival snapshots of the source data will be taken on the source cluster before a sync.
sourceSnapshotExpiration Number: The length of time in seconds to keep snapshots on the source cluster.
sourceSnapshotPattern String: The name pattern for snapshots taken on the source cluster before a sync.
syncExistingSnapshotExpiration Boolean: If set to true, the expire duration for target archival snapshot is the remaining expire duration of source snapshot, requires --sync-existing-snapshot=true
syncExistingTargetSnapshotPattern String: The naming pattern for snapshot on the destination cluster when --sync-existing-snapshot is true
targetCertificateId String: The ID of the target cluster certificate being used for encryption. Set to empty string to disable target certificate verification.
targetCompareInitialSync Boolean: If true, the target creates diffs against the original sync.
targetDetectModifications Boolean: If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.
targetSnapshotAlias String: The alias of the snapshot taken on the target cluster after the sync completes. Do not use the value DEFAULT.
targetSnapshotArchive Boolean: If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.
targetSnapshotExpiration Number: The length of time in seconds to keep snapshots on the target cluster.
targetSnapshotPattern String: The name pattern for snapshots taken on the target cluster after the sync completes. Do not use the value @DEFAULT.
workersPerNode Number: The number of worker threads on a node performing a sync.

Outputs

All input properties are implicitly available as output properties. Additionally, the SynciqPolicy 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 SynciqPolicy Resource

Get an existing SynciqPolicy 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?: SynciqPolicyState, opts?: CustomResourceOptions): SynciqPolicy

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accelerated_failback: Optional[bool] = None,
        action: Optional[str] = None,
        allow_copy_fb: Optional[bool] = None,
        bandwidth_reservation: Optional[float] = None,
        changelist: Optional[bool] = None,
        check_integrity: Optional[bool] = None,
        cloud_deep_copy: Optional[str] = None,
        conflicted: Optional[bool] = None,
        delete_quotas: Optional[bool] = None,
        description: Optional[str] = None,
        disable_file_split: Optional[bool] = None,
        disable_fofb: Optional[bool] = None,
        disable_quota_tmp_dir: Optional[bool] = None,
        disable_stf: Optional[bool] = None,
        enable_hash_tmpdir: Optional[bool] = None,
        enabled: Optional[bool] = None,
        encryption_cipher_list: Optional[str] = None,
        expected_dataloss: Optional[bool] = None,
        file_matching_pattern: Optional[SynciqPolicyFileMatchingPatternArgs] = None,
        force_interface: Optional[bool] = None,
        ignore_recursive_quota: Optional[bool] = None,
        job_delay: Optional[float] = None,
        log_level: Optional[str] = None,
        log_removed_files: Optional[bool] = None,
        name: Optional[str] = None,
        ocsp_address: Optional[str] = None,
        ocsp_issuer_certificate_id: Optional[str] = None,
        password: Optional[str] = None,
        priority: Optional[float] = None,
        report_max_age: Optional[float] = None,
        report_max_count: Optional[float] = None,
        restrict_target_network: Optional[bool] = None,
        rpo_alert: Optional[float] = None,
        schedule: Optional[str] = None,
        skip_lookup: Optional[bool] = None,
        skip_when_source_unmodified: Optional[bool] = None,
        snapshot_sync_existing: Optional[bool] = None,
        snapshot_sync_pattern: Optional[str] = None,
        source_exclude_directories: Optional[Sequence[str]] = None,
        source_include_directories: Optional[Sequence[str]] = None,
        source_network: Optional[SynciqPolicySourceNetworkArgs] = None,
        source_root_path: Optional[str] = None,
        source_snapshot_archive: Optional[bool] = None,
        source_snapshot_expiration: Optional[float] = None,
        source_snapshot_pattern: Optional[str] = None,
        sync_existing_snapshot_expiration: Optional[bool] = None,
        sync_existing_target_snapshot_pattern: Optional[str] = None,
        target_certificate_id: Optional[str] = None,
        target_compare_initial_sync: Optional[bool] = None,
        target_detect_modifications: Optional[bool] = None,
        target_host: Optional[str] = None,
        target_path: Optional[str] = None,
        target_snapshot_alias: Optional[str] = None,
        target_snapshot_archive: Optional[bool] = None,
        target_snapshot_expiration: Optional[float] = None,
        target_snapshot_pattern: Optional[str] = None,
        workers_per_node: Optional[float] = None) -> SynciqPolicy

func GetSynciqPolicy(ctx *Context, name string, id IDInput, state *SynciqPolicyState, opts ...ResourceOption) (*SynciqPolicy, error)

public static SynciqPolicy Get(string name, Input<string> id, SynciqPolicyState? state, CustomResourceOptions? opts = null)

public static SynciqPolicy get(String name, Output<String> id, SynciqPolicyState state, CustomResourceOptions options)

resources:  _:    type: powerscale:SynciqPolicy    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.

The following state arguments are supported:

AcceleratedFailback bool: If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.
Action string: If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.
AllowCopyFb bool: If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.
BandwidthReservation double: The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.
Changelist bool: If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.
CheckIntegrity bool: If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.
CloudDeepCopy string: If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.
Conflicted bool: NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.
DeleteQuotas bool: If true, forcibly remove quotas on the target after they have been removed on the source.
Description string: User-assigned description of this sync policy.
DisableFileSplit bool: NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.
DisableFofb bool: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.
DisableQuotaTmpDir bool: If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.
DisableStf bool: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.
EnableHashTmpdir bool: If true, syncs will use temporary working directory subdirectories to reduce lock contention.
Enabled bool: If true, jobs will be automatically run based on this policy, according to its schedule.
EncryptionCipherList string: The cipher list (comma separated) 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.
ExpectedDataloss bool: NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.
FileMatchingPattern SynciqPolicyFileMatchingPattern: A file matching pattern, organized as an OR'ed set of AND'ed file criteria, for example ((a AND b) OR (x AND y)) used to define a set of files with specific properties. Policies of type 'sync' cannot use 'path' or time criteria in their matching patterns, but policies of type 'copy' can use all listed criteria.
ForceInterface bool: NOTE: This field should not be changed without the help of PowerScale support. 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. If you enable this option, the net.inet.ip.chooseifabyipsrc sysctl should be set.
IgnoreRecursiveQuota bool: If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.
JobDelay double: If schedule is set to when-source-modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).
LogLevel string: Severity an event must reach before it is logged. Accepted values are fatal, error, notice, info, copy, debug, trace.
LogRemovedFiles bool: If true, the system will log any files or directories that are deleted due to a sync.
Name string: User-assigned name of this sync policy.
OcspAddress string: The address of the OCSP responder to which to connect. Set to empty string to disable OCSP.
OcspIssuerCertificateId string: The ID of the certificate authority that issued the certificate whose revocation status is being checked. Set to empty string to disable certificate verification.
Password string: The password for the target cluster. This field is not readable.
Priority double: Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.
ReportMaxAge double: Length of time (in seconds) a policy report will be stored.
ReportMaxCount double: Maximum number of policy reports that will be stored on the system.
RestrictTargetNetwork bool: 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.
RpoAlert double: If schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.
Schedule string: The schedule on which new jobs will be run for this policy.
SkipLookup bool: Skip DNS lookup of target IPs.
SkipWhenSourceUnmodified bool: If true and schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.
SnapshotSyncExisting bool: If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).
SnapshotSyncPattern string: The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is "*").
SourceExcludeDirectories List<string>: Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.
SourceIncludeDirectories List<string>: Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.
SourceNetwork SynciqPolicySourceNetwork: Restricts replication policies on the local cluster to running on the specified subnet and pool.
SourceRootPath string: The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.
SourceSnapshotArchive bool: If true, archival snapshots of the source data will be taken on the source cluster before a sync.
SourceSnapshotExpiration double: The length of time in seconds to keep snapshots on the source cluster.
SourceSnapshotPattern string: The name pattern for snapshots taken on the source cluster before a sync.
SyncExistingSnapshotExpiration bool: If set to true, the expire duration for target archival snapshot is the remaining expire duration of source snapshot, requires --sync-existing-snapshot=true
SyncExistingTargetSnapshotPattern string: The naming pattern for snapshot on the destination cluster when --sync-existing-snapshot is true
TargetCertificateId string: The ID of the target cluster certificate being used for encryption. Set to empty string to disable target certificate verification.
TargetCompareInitialSync bool: If true, the target creates diffs against the original sync.
TargetDetectModifications bool: If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.
TargetHost string: Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.
TargetPath string: Absolute filesystem path on the target cluster for the sync destination.
TargetSnapshotAlias string: The alias of the snapshot taken on the target cluster after the sync completes. Do not use the value DEFAULT.
TargetSnapshotArchive bool: If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.
TargetSnapshotExpiration double: The length of time in seconds to keep snapshots on the target cluster.
TargetSnapshotPattern string: The name pattern for snapshots taken on the target cluster after the sync completes. Do not use the value @DEFAULT.
WorkersPerNode double: The number of worker threads on a node performing a sync.

AcceleratedFailback bool: If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.
Action string: If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.
AllowCopyFb bool: If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.
BandwidthReservation float64: The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.
Changelist bool: If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.
CheckIntegrity bool: If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.
CloudDeepCopy string: If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.
Conflicted bool: NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.
DeleteQuotas bool: If true, forcibly remove quotas on the target after they have been removed on the source.
Description string: User-assigned description of this sync policy.
DisableFileSplit bool: NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.
DisableFofb bool: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.
DisableQuotaTmpDir bool: If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.
DisableStf bool: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.
EnableHashTmpdir bool: If true, syncs will use temporary working directory subdirectories to reduce lock contention.
Enabled bool: If true, jobs will be automatically run based on this policy, according to its schedule.
EncryptionCipherList string: The cipher list (comma separated) 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.
ExpectedDataloss bool: NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.
FileMatchingPattern SynciqPolicyFileMatchingPatternArgs: A file matching pattern, organized as an OR'ed set of AND'ed file criteria, for example ((a AND b) OR (x AND y)) used to define a set of files with specific properties. Policies of type 'sync' cannot use 'path' or time criteria in their matching patterns, but policies of type 'copy' can use all listed criteria.
ForceInterface bool: NOTE: This field should not be changed without the help of PowerScale support. 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. If you enable this option, the net.inet.ip.chooseifabyipsrc sysctl should be set.
IgnoreRecursiveQuota bool: If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.
JobDelay float64: If schedule is set to when-source-modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).
LogLevel string: Severity an event must reach before it is logged. Accepted values are fatal, error, notice, info, copy, debug, trace.
LogRemovedFiles bool: If true, the system will log any files or directories that are deleted due to a sync.
Name string: User-assigned name of this sync policy.
OcspAddress string: The address of the OCSP responder to which to connect. Set to empty string to disable OCSP.
OcspIssuerCertificateId string: The ID of the certificate authority that issued the certificate whose revocation status is being checked. Set to empty string to disable certificate verification.
Password string: The password for the target cluster. This field is not readable.
Priority float64: Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.
ReportMaxAge float64: Length of time (in seconds) a policy report will be stored.
ReportMaxCount float64: Maximum number of policy reports that will be stored on the system.
RestrictTargetNetwork bool: 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.
RpoAlert float64: If schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.
Schedule string: The schedule on which new jobs will be run for this policy.
SkipLookup bool: Skip DNS lookup of target IPs.
SkipWhenSourceUnmodified bool: If true and schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.
SnapshotSyncExisting bool: If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).
SnapshotSyncPattern string: The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is "*").
SourceExcludeDirectories []string: Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.
SourceIncludeDirectories []string: Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.
SourceNetwork SynciqPolicySourceNetworkArgs: Restricts replication policies on the local cluster to running on the specified subnet and pool.
SourceRootPath string: The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.
SourceSnapshotArchive bool: If true, archival snapshots of the source data will be taken on the source cluster before a sync.
SourceSnapshotExpiration float64: The length of time in seconds to keep snapshots on the source cluster.
SourceSnapshotPattern string: The name pattern for snapshots taken on the source cluster before a sync.
SyncExistingSnapshotExpiration bool: If set to true, the expire duration for target archival snapshot is the remaining expire duration of source snapshot, requires --sync-existing-snapshot=true
SyncExistingTargetSnapshotPattern string: The naming pattern for snapshot on the destination cluster when --sync-existing-snapshot is true
TargetCertificateId string: The ID of the target cluster certificate being used for encryption. Set to empty string to disable target certificate verification.
TargetCompareInitialSync bool: If true, the target creates diffs against the original sync.
TargetDetectModifications bool: If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.
TargetHost string: Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.
TargetPath string: Absolute filesystem path on the target cluster for the sync destination.
TargetSnapshotAlias string: The alias of the snapshot taken on the target cluster after the sync completes. Do not use the value DEFAULT.
TargetSnapshotArchive bool: If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.
TargetSnapshotExpiration float64: The length of time in seconds to keep snapshots on the target cluster.
TargetSnapshotPattern string: The name pattern for snapshots taken on the target cluster after the sync completes. Do not use the value @DEFAULT.
WorkersPerNode float64: The number of worker threads on a node performing a sync.

acceleratedFailback Boolean: If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.
action String: If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.
allowCopyFb Boolean: If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.
bandwidthReservation Double: The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.
changelist Boolean: If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.
checkIntegrity Boolean: If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.
cloudDeepCopy String: If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.
conflicted Boolean: NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.
deleteQuotas Boolean: If true, forcibly remove quotas on the target after they have been removed on the source.
description String: User-assigned description of this sync policy.
disableFileSplit Boolean: NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.
disableFofb Boolean: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.
disableQuotaTmpDir Boolean: If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.
disableStf Boolean: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.
enableHashTmpdir Boolean: If true, syncs will use temporary working directory subdirectories to reduce lock contention.
enabled Boolean: If true, jobs will be automatically run based on this policy, according to its schedule.
encryptionCipherList String: The cipher list (comma separated) 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.
expectedDataloss Boolean: NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.
fileMatchingPattern SynciqPolicyFileMatchingPattern: A file matching pattern, organized as an OR'ed set of AND'ed file criteria, for example ((a AND b) OR (x AND y)) used to define a set of files with specific properties. Policies of type 'sync' cannot use 'path' or time criteria in their matching patterns, but policies of type 'copy' can use all listed criteria.
forceInterface Boolean: NOTE: This field should not be changed without the help of PowerScale support. 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. If you enable this option, the net.inet.ip.chooseifabyipsrc sysctl should be set.
ignoreRecursiveQuota Boolean: If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.
jobDelay Double: If schedule is set to when-source-modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).
logLevel String: Severity an event must reach before it is logged. Accepted values are fatal, error, notice, info, copy, debug, trace.
logRemovedFiles Boolean: If true, the system will log any files or directories that are deleted due to a sync.
name String: User-assigned name of this sync policy.
ocspAddress String: The address of the OCSP responder to which to connect. Set to empty string to disable OCSP.
ocspIssuerCertificateId String: The ID of the certificate authority that issued the certificate whose revocation status is being checked. Set to empty string to disable certificate verification.
password String: The password for the target cluster. This field is not readable.
priority Double: Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.
reportMaxAge Double: Length of time (in seconds) a policy report will be stored.
reportMaxCount Double: Maximum number of policy reports that will be stored on the system.
restrictTargetNetwork Boolean: 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.
rpoAlert Double: If schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.
schedule String: The schedule on which new jobs will be run for this policy.
skipLookup Boolean: Skip DNS lookup of target IPs.
skipWhenSourceUnmodified Boolean: If true and schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.
snapshotSyncExisting Boolean: If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).
snapshotSyncPattern String: The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is "*").
sourceExcludeDirectories List<String>: Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.
sourceIncludeDirectories List<String>: Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.
sourceNetwork SynciqPolicySourceNetwork: Restricts replication policies on the local cluster to running on the specified subnet and pool.
sourceRootPath String: The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.
sourceSnapshotArchive Boolean: If true, archival snapshots of the source data will be taken on the source cluster before a sync.
sourceSnapshotExpiration Double: The length of time in seconds to keep snapshots on the source cluster.
sourceSnapshotPattern String: The name pattern for snapshots taken on the source cluster before a sync.
syncExistingSnapshotExpiration Boolean: If set to true, the expire duration for target archival snapshot is the remaining expire duration of source snapshot, requires --sync-existing-snapshot=true
syncExistingTargetSnapshotPattern String: The naming pattern for snapshot on the destination cluster when --sync-existing-snapshot is true
targetCertificateId String: The ID of the target cluster certificate being used for encryption. Set to empty string to disable target certificate verification.
targetCompareInitialSync Boolean: If true, the target creates diffs against the original sync.
targetDetectModifications Boolean: If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.
targetHost String: Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.
targetPath String: Absolute filesystem path on the target cluster for the sync destination.
targetSnapshotAlias String: The alias of the snapshot taken on the target cluster after the sync completes. Do not use the value DEFAULT.
targetSnapshotArchive Boolean: If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.
targetSnapshotExpiration Double: The length of time in seconds to keep snapshots on the target cluster.
targetSnapshotPattern String: The name pattern for snapshots taken on the target cluster after the sync completes. Do not use the value @DEFAULT.
workersPerNode Double: The number of worker threads on a node performing a sync.

acceleratedFailback boolean: If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.
action string: If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.
allowCopyFb boolean: If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.
bandwidthReservation number: The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.
changelist boolean: If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.
checkIntegrity boolean: If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.
cloudDeepCopy string: If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.
conflicted boolean: NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.
deleteQuotas boolean: If true, forcibly remove quotas on the target after they have been removed on the source.
description string: User-assigned description of this sync policy.
disableFileSplit boolean: NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.
disableFofb boolean: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.
disableQuotaTmpDir boolean: If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.
disableStf boolean: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.
enableHashTmpdir boolean: If true, syncs will use temporary working directory subdirectories to reduce lock contention.
enabled boolean: If true, jobs will be automatically run based on this policy, according to its schedule.
encryptionCipherList string: The cipher list (comma separated) 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.
expectedDataloss boolean: NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.
fileMatchingPattern SynciqPolicyFileMatchingPattern: A file matching pattern, organized as an OR'ed set of AND'ed file criteria, for example ((a AND b) OR (x AND y)) used to define a set of files with specific properties. Policies of type 'sync' cannot use 'path' or time criteria in their matching patterns, but policies of type 'copy' can use all listed criteria.
forceInterface boolean: NOTE: This field should not be changed without the help of PowerScale support. 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. If you enable this option, the net.inet.ip.chooseifabyipsrc sysctl should be set.
ignoreRecursiveQuota boolean: If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.
jobDelay number: If schedule is set to when-source-modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).
logLevel string: Severity an event must reach before it is logged. Accepted values are fatal, error, notice, info, copy, debug, trace.
logRemovedFiles boolean: If true, the system will log any files or directories that are deleted due to a sync.
name string: User-assigned name of this sync policy.
ocspAddress string: The address of the OCSP responder to which to connect. Set to empty string to disable OCSP.
ocspIssuerCertificateId string: The ID of the certificate authority that issued the certificate whose revocation status is being checked. Set to empty string to disable certificate verification.
password string: The password for the target cluster. This field is not readable.
priority number: Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.
reportMaxAge number: Length of time (in seconds) a policy report will be stored.
reportMaxCount number: Maximum number of policy reports that will be stored on the system.
restrictTargetNetwork boolean: 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.
rpoAlert number: If schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.
schedule string: The schedule on which new jobs will be run for this policy.
skipLookup boolean: Skip DNS lookup of target IPs.
skipWhenSourceUnmodified boolean: If true and schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.
snapshotSyncExisting boolean: If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).
snapshotSyncPattern string: The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is "*").
sourceExcludeDirectories string[]: Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.
sourceIncludeDirectories string[]: Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.
sourceNetwork SynciqPolicySourceNetwork: Restricts replication policies on the local cluster to running on the specified subnet and pool.
sourceRootPath string: The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.
sourceSnapshotArchive boolean: If true, archival snapshots of the source data will be taken on the source cluster before a sync.
sourceSnapshotExpiration number: The length of time in seconds to keep snapshots on the source cluster.
sourceSnapshotPattern string: The name pattern for snapshots taken on the source cluster before a sync.
syncExistingSnapshotExpiration boolean: If set to true, the expire duration for target archival snapshot is the remaining expire duration of source snapshot, requires --sync-existing-snapshot=true
syncExistingTargetSnapshotPattern string: The naming pattern for snapshot on the destination cluster when --sync-existing-snapshot is true
targetCertificateId string: The ID of the target cluster certificate being used for encryption. Set to empty string to disable target certificate verification.
targetCompareInitialSync boolean: If true, the target creates diffs against the original sync.
targetDetectModifications boolean: If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.
targetHost string: Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.
targetPath string: Absolute filesystem path on the target cluster for the sync destination.
targetSnapshotAlias string: The alias of the snapshot taken on the target cluster after the sync completes. Do not use the value DEFAULT.
targetSnapshotArchive boolean: If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.
targetSnapshotExpiration number: The length of time in seconds to keep snapshots on the target cluster.
targetSnapshotPattern string: The name pattern for snapshots taken on the target cluster after the sync completes. Do not use the value @DEFAULT.
workersPerNode number: The number of worker threads on a node performing a sync.

accelerated_failback bool: If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.
action str: If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.
allow_copy_fb bool: If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.
bandwidth_reservation float: The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.
changelist bool: If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.
check_integrity bool: If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.
cloud_deep_copy str: If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.
conflicted bool: NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.
delete_quotas bool: If true, forcibly remove quotas on the target after they have been removed on the source.
description str: User-assigned description of this sync policy.
disable_file_split bool: NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.
disable_fofb bool: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.
disable_quota_tmp_dir bool: If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.
disable_stf bool: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.
enable_hash_tmpdir bool: If true, syncs will use temporary working directory subdirectories to reduce lock contention.
enabled bool: If true, jobs will be automatically run based on this policy, according to its schedule.
encryption_cipher_list str: The cipher list (comma separated) 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.
expected_dataloss bool: NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.
file_matching_pattern SynciqPolicyFileMatchingPatternArgs: A file matching pattern, organized as an OR'ed set of AND'ed file criteria, for example ((a AND b) OR (x AND y)) used to define a set of files with specific properties. Policies of type 'sync' cannot use 'path' or time criteria in their matching patterns, but policies of type 'copy' can use all listed criteria.
force_interface bool: NOTE: This field should not be changed without the help of PowerScale support. 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. If you enable this option, the net.inet.ip.chooseifabyipsrc sysctl should be set.
ignore_recursive_quota bool: If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.
job_delay float: If schedule is set to when-source-modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).
log_level str: Severity an event must reach before it is logged. Accepted values are fatal, error, notice, info, copy, debug, trace.
log_removed_files bool: If true, the system will log any files or directories that are deleted due to a sync.
name str: User-assigned name of this sync policy.
ocsp_address str: The address of the OCSP responder to which to connect. Set to empty string to disable OCSP.
ocsp_issuer_certificate_id str: The ID of the certificate authority that issued the certificate whose revocation status is being checked. Set to empty string to disable certificate verification.
password str: The password for the target cluster. This field is not readable.
priority float: Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.
report_max_age float: Length of time (in seconds) a policy report will be stored.
report_max_count float: Maximum number of policy reports that will be stored on the system.
restrict_target_network bool: 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_alert float: If schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.
schedule str: The schedule on which new jobs will be run for this policy.
skip_lookup bool: Skip DNS lookup of target IPs.
skip_when_source_unmodified bool: If true and schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.
snapshot_sync_existing bool: If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).
snapshot_sync_pattern str: The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is "*").
source_exclude_directories Sequence[str]: Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.
source_include_directories Sequence[str]: Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.
source_network SynciqPolicySourceNetworkArgs: Restricts replication policies on the local cluster to running on the specified subnet and pool.
source_root_path str: The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.
source_snapshot_archive bool: If true, archival snapshots of the source data will be taken on the source cluster before a sync.
source_snapshot_expiration float: The length of time in seconds to keep snapshots on the source cluster.
source_snapshot_pattern str: The name pattern for snapshots taken on the source cluster before a sync.
sync_existing_snapshot_expiration bool: If set to true, the expire duration for target archival snapshot is the remaining expire duration of source snapshot, requires --sync-existing-snapshot=true
sync_existing_target_snapshot_pattern str: The naming pattern for snapshot on the destination cluster when --sync-existing-snapshot is true
target_certificate_id str: The ID of the target cluster certificate being used for encryption. Set to empty string to disable target certificate verification.
target_compare_initial_sync bool: If true, the target creates diffs against the original sync.
target_detect_modifications bool: If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.
target_host str: Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.
target_path str: Absolute filesystem path on the target cluster for the sync destination.
target_snapshot_alias str: The alias of the snapshot taken on the target cluster after the sync completes. Do not use the value DEFAULT.
target_snapshot_archive bool: If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.
target_snapshot_expiration float: The length of time in seconds to keep snapshots on the target cluster.
target_snapshot_pattern str: The name pattern for snapshots taken on the target cluster after the sync completes. Do not use the value @DEFAULT.
workers_per_node float: The number of worker threads on a node performing a sync.

acceleratedFailback Boolean: If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.
action String: If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.
allowCopyFb Boolean: If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.
bandwidthReservation Number: The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.
changelist Boolean: If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.
checkIntegrity Boolean: If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.
cloudDeepCopy String: If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.
conflicted Boolean: NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.
deleteQuotas Boolean: If true, forcibly remove quotas on the target after they have been removed on the source.
description String: User-assigned description of this sync policy.
disableFileSplit Boolean: NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.
disableFofb Boolean: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.
disableQuotaTmpDir Boolean: If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.
disableStf Boolean: NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.
enableHashTmpdir Boolean: If true, syncs will use temporary working directory subdirectories to reduce lock contention.
enabled Boolean: If true, jobs will be automatically run based on this policy, according to its schedule.
encryptionCipherList String: The cipher list (comma separated) 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.
expectedDataloss Boolean: NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.
fileMatchingPattern Property Map: A file matching pattern, organized as an OR'ed set of AND'ed file criteria, for example ((a AND b) OR (x AND y)) used to define a set of files with specific properties. Policies of type 'sync' cannot use 'path' or time criteria in their matching patterns, but policies of type 'copy' can use all listed criteria.
forceInterface Boolean: NOTE: This field should not be changed without the help of PowerScale support. 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. If you enable this option, the net.inet.ip.chooseifabyipsrc sysctl should be set.
ignoreRecursiveQuota Boolean: If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.
jobDelay Number: If schedule is set to when-source-modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).
logLevel String: Severity an event must reach before it is logged. Accepted values are fatal, error, notice, info, copy, debug, trace.
logRemovedFiles Boolean: If true, the system will log any files or directories that are deleted due to a sync.
name String: User-assigned name of this sync policy.
ocspAddress String: The address of the OCSP responder to which to connect. Set to empty string to disable OCSP.
ocspIssuerCertificateId String: The ID of the certificate authority that issued the certificate whose revocation status is being checked. Set to empty string to disable certificate verification.
password String: The password for the target cluster. This field is not readable.
priority Number: Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.
reportMaxAge Number: Length of time (in seconds) a policy report will be stored.
reportMaxCount Number: Maximum number of policy reports that will be stored on the system.
restrictTargetNetwork Boolean: 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.
rpoAlert Number: If schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.
schedule String: The schedule on which new jobs will be run for this policy.
skipLookup Boolean: Skip DNS lookup of target IPs.
skipWhenSourceUnmodified Boolean: If true and schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.
snapshotSyncExisting Boolean: If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).
snapshotSyncPattern String: The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is "*").
sourceExcludeDirectories List<String>: Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.
sourceIncludeDirectories List<String>: Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.
sourceNetwork Property Map: Restricts replication policies on the local cluster to running on the specified subnet and pool.
sourceRootPath String: The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.
sourceSnapshotArchive Boolean: If true, archival snapshots of the source data will be taken on the source cluster before a sync.
sourceSnapshotExpiration Number: The length of time in seconds to keep snapshots on the source cluster.
sourceSnapshotPattern String: The name pattern for snapshots taken on the source cluster before a sync.
syncExistingSnapshotExpiration Boolean: If set to true, the expire duration for target archival snapshot is the remaining expire duration of source snapshot, requires --sync-existing-snapshot=true
syncExistingTargetSnapshotPattern String: The naming pattern for snapshot on the destination cluster when --sync-existing-snapshot is true
targetCertificateId String: The ID of the target cluster certificate being used for encryption. Set to empty string to disable target certificate verification.
targetCompareInitialSync Boolean: If true, the target creates diffs against the original sync.
targetDetectModifications Boolean: If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.
targetHost String: Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.
targetPath String: Absolute filesystem path on the target cluster for the sync destination.
targetSnapshotAlias String: The alias of the snapshot taken on the target cluster after the sync completes. Do not use the value DEFAULT.
targetSnapshotArchive Boolean: If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.
targetSnapshotExpiration Number: The length of time in seconds to keep snapshots on the target cluster.
targetSnapshotPattern String: The name pattern for snapshots taken on the target cluster after the sync completes. Do not use the value @DEFAULT.
workersPerNode Number: The number of worker threads on a node performing a sync.

Supporting Types

SynciqPolicyFileMatchingPattern, SynciqPolicyFileMatchingPatternArgs

OrCriterias List<SynciqPolicyFileMatchingPatternOrCriteria>: An array containing objects with "andcriteria" properties, each set of andcriteria will be logically OR'ed together to create the full file matching pattern.

OrCriterias []SynciqPolicyFileMatchingPatternOrCriteria: An array containing objects with "andcriteria" properties, each set of andcriteria will be logically OR'ed together to create the full file matching pattern.

orCriterias List<SynciqPolicyFileMatchingPatternOrCriteria>: An array containing objects with "andcriteria" properties, each set of andcriteria will be logically OR'ed together to create the full file matching pattern.

orCriterias SynciqPolicyFileMatchingPatternOrCriteria[]: An array containing objects with "andcriteria" properties, each set of andcriteria will be logically OR'ed together to create the full file matching pattern.

or_criterias Sequence[SynciqPolicyFileMatchingPatternOrCriteria]: An array containing objects with "andcriteria" properties, each set of andcriteria will be logically OR'ed together to create the full file matching pattern.

orCriterias List<Property Map>: An array containing objects with "andcriteria" properties, each set of andcriteria will be logically OR'ed together to create the full file matching pattern.

SynciqPolicyFileMatchingPatternOrCriteria, SynciqPolicyFileMatchingPatternOrCriteriaArgs

AndCriterias List<SynciqPolicyFileMatchingPatternOrCriteriaAndCriteria>: An array containing individual file criterion objects each describing one criterion. These are logically AND'ed together to form a set of criteria.

AndCriterias []SynciqPolicyFileMatchingPatternOrCriteriaAndCriteria: An array containing individual file criterion objects each describing one criterion. These are logically AND'ed together to form a set of criteria.

andCriterias List<SynciqPolicyFileMatchingPatternOrCriteriaAndCriteria>: An array containing individual file criterion objects each describing one criterion. These are logically AND'ed together to form a set of criteria.

andCriterias SynciqPolicyFileMatchingPatternOrCriteriaAndCriteria[]: An array containing individual file criterion objects each describing one criterion. These are logically AND'ed together to form a set of criteria.

and_criterias Sequence[SynciqPolicyFileMatchingPatternOrCriteriaAndCriteria]: An array containing individual file criterion objects each describing one criterion. These are logically AND'ed together to form a set of criteria.

andCriterias List<Property Map>: An array containing individual file criterion objects each describing one criterion. These are logically AND'ed together to form a set of criteria.

SynciqPolicyFileMatchingPatternOrCriteriaAndCriteria, SynciqPolicyFileMatchingPatternOrCriteriaAndCriteriaArgs

AttributeExists bool: For "custom_attribute" type criteria. The file will match as long as the attribute named by "field" exists. Default is true.
CaseSensitive bool: If true, the value comparison will be case sensitive. Default is true.
Field string: The name of the file attribute to match on (only required if this is a custom_attribute type criterion). Default is an empty string "".
Operator string: How to compare the specified attribute of each file to the specified value. Possible values are: ==, !=, >, >=, <, <=, !. Default is ==.
Type string: The type of this criterion, that is, which file attribute to match on. Accepted values are , name, path, accessed_time, birth_time, changed_time, size, file_type, posix_regex_name, user_name, user_id, group_name, group_id, no_user, no_group.
Value string: The value to compare the specified attribute of each file to.
WholeWord bool: If true, the attribute must match the entire word. Default is true.

AttributeExists bool: For "custom_attribute" type criteria. The file will match as long as the attribute named by "field" exists. Default is true.
CaseSensitive bool: If true, the value comparison will be case sensitive. Default is true.
Field string: The name of the file attribute to match on (only required if this is a custom_attribute type criterion). Default is an empty string "".
Operator string: How to compare the specified attribute of each file to the specified value. Possible values are: ==, !=, >, >=, <, <=, !. Default is ==.
Type string: The type of this criterion, that is, which file attribute to match on. Accepted values are , name, path, accessed_time, birth_time, changed_time, size, file_type, posix_regex_name, user_name, user_id, group_name, group_id, no_user, no_group.
Value string: The value to compare the specified attribute of each file to.
WholeWord bool: If true, the attribute must match the entire word. Default is true.

attributeExists Boolean: For "custom_attribute" type criteria. The file will match as long as the attribute named by "field" exists. Default is true.
caseSensitive Boolean: If true, the value comparison will be case sensitive. Default is true.
field String: The name of the file attribute to match on (only required if this is a custom_attribute type criterion). Default is an empty string "".
operator String: How to compare the specified attribute of each file to the specified value. Possible values are: ==, !=, >, >=, <, <=, !. Default is ==.
type String: The type of this criterion, that is, which file attribute to match on. Accepted values are , name, path, accessed_time, birth_time, changed_time, size, file_type, posix_regex_name, user_name, user_id, group_name, group_id, no_user, no_group.
value String: The value to compare the specified attribute of each file to.
wholeWord Boolean: If true, the attribute must match the entire word. Default is true.

attributeExists boolean: For "custom_attribute" type criteria. The file will match as long as the attribute named by "field" exists. Default is true.
caseSensitive boolean: If true, the value comparison will be case sensitive. Default is true.
field string: The name of the file attribute to match on (only required if this is a custom_attribute type criterion). Default is an empty string "".
operator string: How to compare the specified attribute of each file to the specified value. Possible values are: ==, !=, >, >=, <, <=, !. Default is ==.
type string: The type of this criterion, that is, which file attribute to match on. Accepted values are , name, path, accessed_time, birth_time, changed_time, size, file_type, posix_regex_name, user_name, user_id, group_name, group_id, no_user, no_group.
value string: The value to compare the specified attribute of each file to.
wholeWord boolean: If true, the attribute must match the entire word. Default is true.

attribute_exists bool: For "custom_attribute" type criteria. The file will match as long as the attribute named by "field" exists. Default is true.
case_sensitive bool: If true, the value comparison will be case sensitive. Default is true.
field str: The name of the file attribute to match on (only required if this is a custom_attribute type criterion). Default is an empty string "".
operator str: How to compare the specified attribute of each file to the specified value. Possible values are: ==, !=, >, >=, <, <=, !. Default is ==.
type str: The type of this criterion, that is, which file attribute to match on. Accepted values are , name, path, accessed_time, birth_time, changed_time, size, file_type, posix_regex_name, user_name, user_id, group_name, group_id, no_user, no_group.
value str: The value to compare the specified attribute of each file to.
whole_word bool: If true, the attribute must match the entire word. Default is true.

attributeExists Boolean: For "custom_attribute" type criteria. The file will match as long as the attribute named by "field" exists. Default is true.
caseSensitive Boolean: If true, the value comparison will be case sensitive. Default is true.
field String: The name of the file attribute to match on (only required if this is a custom_attribute type criterion). Default is an empty string "".
operator String: How to compare the specified attribute of each file to the specified value. Possible values are: ==, !=, >, >=, <, <=, !. Default is ==.
type String: The type of this criterion, that is, which file attribute to match on. Accepted values are , name, path, accessed_time, birth_time, changed_time, size, file_type, posix_regex_name, user_name, user_id, group_name, group_id, no_user, no_group.
value String: The value to compare the specified attribute of each file to.
wholeWord Boolean: If true, the attribute must match the entire word. Default is true.

SynciqPolicySourceNetwork, SynciqPolicySourceNetworkArgs

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.

Import

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/synciqPolicy:SynciqPolicy policy <policy name>

Example:

$ pulumi import powerscale:index/synciqPolicy:SynciqPolicy policy "policy1"

after running this command, populate the name field and other required 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.

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

dell/terraform-provider-powerscale

powerscale.SynciqPolicy

On this page

On this page

Example Usage

Create SynciqPolicy Resource

Constructor syntax

Parameters

Constructor example

SynciqPolicy Resource Properties

Inputs

Outputs

Look up Existing SynciqPolicy Resource

Supporting Types

SynciqPolicyFileMatchingPattern, SynciqPolicyFileMatchingPatternArgs

SynciqPolicyFileMatchingPatternOrCriteria, SynciqPolicyFileMatchingPatternOrCriteriaArgs

SynciqPolicyFileMatchingPatternOrCriteriaAndCriteria, SynciqPolicyFileMatchingPatternOrCriteriaAndCriteriaArgs

SynciqPolicySourceNetwork, SynciqPolicySourceNetworkArgs

Import

Package Details

On this page

On this page