Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Powerscale Provider
  3. API Docs
  4. SynciqReplicationJob
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
dell/terraform-provider-powerscale

powerscale.SynciqReplicationJob

Explore with Pulumi AI

powerscale logo
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
dell/terraform-provider-powerscale

    The PowerScale SyncIQ ReplicationJob resource provides a means of managing replication jobs on PowerScale clusters. This resource allows for the manual triggering of replication jobs to replicate data from a source PowerScale cluster to a target PowerScale cluster. Note: The replication job is an asynchronous operation, and this resource does not provide real-time monitoring of the job’s status. To check the status of the job,please use the powerscale.getSynciqReplicationReport datasource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as powerscale from "@pulumi/powerscale";

// PowerScale SynIQ Replication Job allows you to manage the SyncIQ Replication Jobs on the Powerscale array
const job1 = new powerscale.SynciqReplicationJob("job1", {
    action: "run",
    synciqReplicationJobId: "TerraformPolicy",
    isPaused: false,
});
// change job state to running or paused.

    import pulumi
import pulumi_powerscale as powerscale

# PowerScale SynIQ Replication Job allows you to manage the SyncIQ Replication Jobs on the Powerscale array
job1 = powerscale.SynciqReplicationJob("job1",
    action="run",
    synciq_replication_job_id="TerraformPolicy",
    is_paused=False)
# change job state to running or paused.

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/powerscale/powerscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// PowerScale SynIQ Replication Job allows you to manage the SyncIQ Replication Jobs on the Powerscale array
		_, err := powerscale.NewSynciqReplicationJob(ctx, "job1", &powerscale.SynciqReplicationJobArgs{
			Action:                 pulumi.String("run"),
			SynciqReplicationJobId: pulumi.String("TerraformPolicy"),
			IsPaused:               pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Powerscale = Pulumi.Powerscale;

return await Deployment.RunAsync(() => 
{
    // PowerScale SynIQ Replication Job allows you to manage the SyncIQ Replication Jobs on the Powerscale array
    var job1 = new Powerscale.SynciqReplicationJob("job1", new()
    {
        Action = "run",
        SynciqReplicationJobId = "TerraformPolicy",
        IsPaused = false,
    });

    // change job state to running or paused.
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.powerscale.SynciqReplicationJob;
import com.pulumi.powerscale.SynciqReplicationJobArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // PowerScale SynIQ Replication Job allows you to manage the SyncIQ Replication Jobs on the Powerscale array
        var job1 = new SynciqReplicationJob("job1", SynciqReplicationJobArgs.builder()
            .action("run")
            .synciqReplicationJobId("TerraformPolicy")
            .isPaused(false)
            .build());

        // change job state to running or paused.
    }
}

    resources:
  # PowerScale SynIQ Replication Job allows you to manage the SyncIQ Replication Jobs on the Powerscale array
  job1:
    type: powerscale:SynciqReplicationJob
    properties:
      action: run
      # action can be run, test, resync_prep, allow_write or allow_write_revert
      synciqReplicationJobId: TerraformPolicy
      # id/name of the synciq policy, use synciq policy resource to create policy.
      isPaused: false

    Create SynciqReplicationJob Resource

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

    Constructor syntax

    new SynciqReplicationJob(name: string, args: SynciqReplicationJobArgs, opts?: CustomResourceOptions);
    @overload
def SynciqReplicationJob(resource_name: str,
                         args: SynciqReplicationJobArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def SynciqReplicationJob(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         action: Optional[str] = None,
                         synciq_replication_job_id: Optional[str] = None,
                         is_paused: Optional[bool] = None,
                         wait_time: Optional[float] = None)
    func NewSynciqReplicationJob(ctx *Context, name string, args SynciqReplicationJobArgs, opts ...ResourceOption) (*SynciqReplicationJob, error)
    public SynciqReplicationJob(string name, SynciqReplicationJobArgs args, CustomResourceOptions? opts = null)
    public SynciqReplicationJob(String name, SynciqReplicationJobArgs args)
public SynciqReplicationJob(String name, SynciqReplicationJobArgs args, CustomResourceOptions options)

    type: powerscale:SynciqReplicationJob
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 SynciqReplicationJobArgs
    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 SynciqReplicationJobArgs
    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 SynciqReplicationJobArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SynciqReplicationJobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SynciqReplicationJobArgs
    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 synciqReplicationJobResource = new Powerscale.SynciqReplicationJob("synciqReplicationJobResource", new()
{
    Action = "string",
    SynciqReplicationJobId = "string",
    IsPaused = false,
    WaitTime = 0,
});

    example, err := powerscale.NewSynciqReplicationJob(ctx, "synciqReplicationJobResource", &powerscale.SynciqReplicationJobArgs{
	Action:                 pulumi.String("string"),
	SynciqReplicationJobId: pulumi.String("string"),
	IsPaused:               pulumi.Bool(false),
	WaitTime:               pulumi.Float64(0),
})

    var synciqReplicationJobResource = new SynciqReplicationJob("synciqReplicationJobResource", SynciqReplicationJobArgs.builder()
    .action("string")
    .synciqReplicationJobId("string")
    .isPaused(false)
    .waitTime(0)
    .build());

    synciq_replication_job_resource = powerscale.SynciqReplicationJob("synciqReplicationJobResource",
    action="string",
    synciq_replication_job_id="string",
    is_paused=False,
    wait_time=0)

    const synciqReplicationJobResource = new powerscale.SynciqReplicationJob("synciqReplicationJobResource", {
    action: "string",
    synciqReplicationJobId: "string",
    isPaused: false,
    waitTime: 0,
});

    type: powerscale:SynciqReplicationJob
properties:
    action: string
    isPaused: false
    synciqReplicationJobId: string
    waitTime: 0

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

    Action string
    Action for the job run - to start the replication job using synciq policy test - to test the replication job using synciq policy, resyncprep - Resyncprep is a preparation step in PowerScale SyncIQ replication jobs that helps ensure a successful replication operation by performing a series of checks and verifications on the source and target volumes before starting the replication process., allowwrite - allowwrite determines whether the replication job allows writes to the target volume during the replication process. When configured, the target volume is writable, and any changes made to the target volume will be replicated to the source volume. This is useful in scenarios where you need to make changes to the target volume, such as updating files or creating new files, while the replication job is running., allowwriterevert - allowwriterevert determines whether the replication job allows writes to the target volume when reverting a replication job. When configure, the target volume is writable during the revert process, allowing changes made to the target volume during the revert process to be replicated to the source volume.
    SynciqReplicationJobId string
    ID/Name of the policy
    IsPaused bool
    change job state to running or paused.
    WaitTime double
    Wait Time for the job
    Action string
    Action for the job run - to start the replication job using synciq policy test - to test the replication job using synciq policy, resyncprep - Resyncprep is a preparation step in PowerScale SyncIQ replication jobs that helps ensure a successful replication operation by performing a series of checks and verifications on the source and target volumes before starting the replication process., allowwrite - allowwrite determines whether the replication job allows writes to the target volume during the replication process. When configured, the target volume is writable, and any changes made to the target volume will be replicated to the source volume. This is useful in scenarios where you need to make changes to the target volume, such as updating files or creating new files, while the replication job is running., allowwriterevert - allowwriterevert determines whether the replication job allows writes to the target volume when reverting a replication job. When configure, the target volume is writable during the revert process, allowing changes made to the target volume during the revert process to be replicated to the source volume.
    SynciqReplicationJobId string
    ID/Name of the policy
    IsPaused bool
    change job state to running or paused.
    WaitTime float64
    Wait Time for the job
    action String
    Action for the job run - to start the replication job using synciq policy test - to test the replication job using synciq policy, resyncprep - Resyncprep is a preparation step in PowerScale SyncIQ replication jobs that helps ensure a successful replication operation by performing a series of checks and verifications on the source and target volumes before starting the replication process., allowwrite - allowwrite determines whether the replication job allows writes to the target volume during the replication process. When configured, the target volume is writable, and any changes made to the target volume will be replicated to the source volume. This is useful in scenarios where you need to make changes to the target volume, such as updating files or creating new files, while the replication job is running., allowwriterevert - allowwriterevert determines whether the replication job allows writes to the target volume when reverting a replication job. When configure, the target volume is writable during the revert process, allowing changes made to the target volume during the revert process to be replicated to the source volume.
    synciqReplicationJobId String
    ID/Name of the policy
    isPaused Boolean
    change job state to running or paused.
    waitTime Double
    Wait Time for the job
    action string
    Action for the job run - to start the replication job using synciq policy test - to test the replication job using synciq policy, resyncprep - Resyncprep is a preparation step in PowerScale SyncIQ replication jobs that helps ensure a successful replication operation by performing a series of checks and verifications on the source and target volumes before starting the replication process., allowwrite - allowwrite determines whether the replication job allows writes to the target volume during the replication process. When configured, the target volume is writable, and any changes made to the target volume will be replicated to the source volume. This is useful in scenarios where you need to make changes to the target volume, such as updating files or creating new files, while the replication job is running., allowwriterevert - allowwriterevert determines whether the replication job allows writes to the target volume when reverting a replication job. When configure, the target volume is writable during the revert process, allowing changes made to the target volume during the revert process to be replicated to the source volume.
    synciqReplicationJobId string
    ID/Name of the policy
    isPaused boolean
    change job state to running or paused.
    waitTime number
    Wait Time for the job
    action str
    Action for the job run - to start the replication job using synciq policy test - to test the replication job using synciq policy, resyncprep - Resyncprep is a preparation step in PowerScale SyncIQ replication jobs that helps ensure a successful replication operation by performing a series of checks and verifications on the source and target volumes before starting the replication process., allowwrite - allowwrite determines whether the replication job allows writes to the target volume during the replication process. When configured, the target volume is writable, and any changes made to the target volume will be replicated to the source volume. This is useful in scenarios where you need to make changes to the target volume, such as updating files or creating new files, while the replication job is running., allowwriterevert - allowwriterevert determines whether the replication job allows writes to the target volume when reverting a replication job. When configure, the target volume is writable during the revert process, allowing changes made to the target volume during the revert process to be replicated to the source volume.
    synciq_replication_job_id str
    ID/Name of the policy
    is_paused bool
    change job state to running or paused.
    wait_time float
    Wait Time for the job
    action String
    Action for the job run - to start the replication job using synciq policy test - to test the replication job using synciq policy, resyncprep - Resyncprep is a preparation step in PowerScale SyncIQ replication jobs that helps ensure a successful replication operation by performing a series of checks and verifications on the source and target volumes before starting the replication process., allowwrite - allowwrite determines whether the replication job allows writes to the target volume during the replication process. When configured, the target volume is writable, and any changes made to the target volume will be replicated to the source volume. This is useful in scenarios where you need to make changes to the target volume, such as updating files or creating new files, while the replication job is running., allowwriterevert - allowwriterevert determines whether the replication job allows writes to the target volume when reverting a replication job. When configure, the target volume is writable during the revert process, allowing changes made to the target volume during the revert process to be replicated to the source volume.
    synciqReplicationJobId String
    ID/Name of the policy
    isPaused Boolean
    change job state to running or paused.
    waitTime Number
    Wait Time for the job

    Outputs

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

    Get an existing SynciqReplicationJob 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?: SynciqReplicationJobState, opts?: CustomResourceOptions): SynciqReplicationJob
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        is_paused: Optional[bool] = None,
        synciq_replication_job_id: Optional[str] = None,
        wait_time: Optional[float] = None) -> SynciqReplicationJob
    func GetSynciqReplicationJob(ctx *Context, name string, id IDInput, state *SynciqReplicationJobState, opts ...ResourceOption) (*SynciqReplicationJob, error)
    public static SynciqReplicationJob Get(string name, Input<string> id, SynciqReplicationJobState? state, CustomResourceOptions? opts = null)
    public static SynciqReplicationJob get(String name, Output<String> id, SynciqReplicationJobState state, CustomResourceOptions options)
    resources:  _:    type: powerscale:SynciqReplicationJob    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:
    Action string
    Action for the job run - to start the replication job using synciq policy test - to test the replication job using synciq policy, resyncprep - Resyncprep is a preparation step in PowerScale SyncIQ replication jobs that helps ensure a successful replication operation by performing a series of checks and verifications on the source and target volumes before starting the replication process., allowwrite - allowwrite determines whether the replication job allows writes to the target volume during the replication process. When configured, the target volume is writable, and any changes made to the target volume will be replicated to the source volume. This is useful in scenarios where you need to make changes to the target volume, such as updating files or creating new files, while the replication job is running., allowwriterevert - allowwriterevert determines whether the replication job allows writes to the target volume when reverting a replication job. When configure, the target volume is writable during the revert process, allowing changes made to the target volume during the revert process to be replicated to the source volume.
    IsPaused bool
    change job state to running or paused.
    SynciqReplicationJobId string
    ID/Name of the policy
    WaitTime double
    Wait Time for the job
    Action string
    Action for the job run - to start the replication job using synciq policy test - to test the replication job using synciq policy, resyncprep - Resyncprep is a preparation step in PowerScale SyncIQ replication jobs that helps ensure a successful replication operation by performing a series of checks and verifications on the source and target volumes before starting the replication process., allowwrite - allowwrite determines whether the replication job allows writes to the target volume during the replication process. When configured, the target volume is writable, and any changes made to the target volume will be replicated to the source volume. This is useful in scenarios where you need to make changes to the target volume, such as updating files or creating new files, while the replication job is running., allowwriterevert - allowwriterevert determines whether the replication job allows writes to the target volume when reverting a replication job. When configure, the target volume is writable during the revert process, allowing changes made to the target volume during the revert process to be replicated to the source volume.
    IsPaused bool
    change job state to running or paused.
    SynciqReplicationJobId string
    ID/Name of the policy
    WaitTime float64
    Wait Time for the job
    action String
    Action for the job run - to start the replication job using synciq policy test - to test the replication job using synciq policy, resyncprep - Resyncprep is a preparation step in PowerScale SyncIQ replication jobs that helps ensure a successful replication operation by performing a series of checks and verifications on the source and target volumes before starting the replication process., allowwrite - allowwrite determines whether the replication job allows writes to the target volume during the replication process. When configured, the target volume is writable, and any changes made to the target volume will be replicated to the source volume. This is useful in scenarios where you need to make changes to the target volume, such as updating files or creating new files, while the replication job is running., allowwriterevert - allowwriterevert determines whether the replication job allows writes to the target volume when reverting a replication job. When configure, the target volume is writable during the revert process, allowing changes made to the target volume during the revert process to be replicated to the source volume.
    isPaused Boolean
    change job state to running or paused.
    synciqReplicationJobId String
    ID/Name of the policy
    waitTime Double
    Wait Time for the job
    action string
    Action for the job run - to start the replication job using synciq policy test - to test the replication job using synciq policy, resyncprep - Resyncprep is a preparation step in PowerScale SyncIQ replication jobs that helps ensure a successful replication operation by performing a series of checks and verifications on the source and target volumes before starting the replication process., allowwrite - allowwrite determines whether the replication job allows writes to the target volume during the replication process. When configured, the target volume is writable, and any changes made to the target volume will be replicated to the source volume. This is useful in scenarios where you need to make changes to the target volume, such as updating files or creating new files, while the replication job is running., allowwriterevert - allowwriterevert determines whether the replication job allows writes to the target volume when reverting a replication job. When configure, the target volume is writable during the revert process, allowing changes made to the target volume during the revert process to be replicated to the source volume.
    isPaused boolean
    change job state to running or paused.
    synciqReplicationJobId string
    ID/Name of the policy
    waitTime number
    Wait Time for the job
    action str
    Action for the job run - to start the replication job using synciq policy test - to test the replication job using synciq policy, resyncprep - Resyncprep is a preparation step in PowerScale SyncIQ replication jobs that helps ensure a successful replication operation by performing a series of checks and verifications on the source and target volumes before starting the replication process., allowwrite - allowwrite determines whether the replication job allows writes to the target volume during the replication process. When configured, the target volume is writable, and any changes made to the target volume will be replicated to the source volume. This is useful in scenarios where you need to make changes to the target volume, such as updating files or creating new files, while the replication job is running., allowwriterevert - allowwriterevert determines whether the replication job allows writes to the target volume when reverting a replication job. When configure, the target volume is writable during the revert process, allowing changes made to the target volume during the revert process to be replicated to the source volume.
    is_paused bool
    change job state to running or paused.
    synciq_replication_job_id str
    ID/Name of the policy
    wait_time float
    Wait Time for the job
    action String
    Action for the job run - to start the replication job using synciq policy test - to test the replication job using synciq policy, resyncprep - Resyncprep is a preparation step in PowerScale SyncIQ replication jobs that helps ensure a successful replication operation by performing a series of checks and verifications on the source and target volumes before starting the replication process., allowwrite - allowwrite determines whether the replication job allows writes to the target volume during the replication process. When configured, the target volume is writable, and any changes made to the target volume will be replicated to the source volume. This is useful in scenarios where you need to make changes to the target volume, such as updating files or creating new files, while the replication job is running., allowwriterevert - allowwriterevert determines whether the replication job allows writes to the target volume when reverting a replication job. When configure, the target volume is writable during the revert process, allowing changes made to the target volume during the revert process to be replicated to the source volume.
    isPaused Boolean
    change job state to running or paused.
    synciqReplicationJobId String
    ID/Name of the policy
    waitTime Number
    Wait Time for the job

    Package Details

    Repository
    powerscale dell/terraform-provider-powerscale
    License
    Notes
    This Pulumi package is based on the powerscale Terraform Provider.
    powerscale logo
    powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
    dell/terraform-provider-powerscale