1. Packages
  2. Packages
  3. Proxmox Virtual Environment (Proxmox VE)
  4. API Docs
  5. ReplicationLegacy
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.1.0
published on Sunday, Apr 26, 2026 by Daniel Muehlbachler-Pietrzykowski
proxmoxve logo
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.1.0
published on Sunday, Apr 26, 2026 by Daniel Muehlbachler-Pietrzykowski

    Deprecated: Use proxmoxve.Replication instead. This resource will be removed in v1.0.

    Manages Proxmox VE Replication.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as proxmoxve from "@muhlba91/pulumi-proxmoxve";
    
    // Replication
    const exampleReplication1 = new proxmoxve.ReplicationLegacy("example_replication_1", {
        resourceId: "100-0",
        target: "pve-02",
        type: "local",
        disable: false,
        comment: "Replication to pve-02 every 30 min",
        schedule: "*/30",
    });
    
    import pulumi
    import pulumi_proxmoxve as proxmoxve
    
    # Replication
    example_replication1 = proxmoxve.ReplicationLegacy("example_replication_1",
        resource_id="100-0",
        target="pve-02",
        type="local",
        disable=False,
        comment="Replication to pve-02 every 30 min",
        schedule="*/30")
    
    package main
    
    import (
    	"github.com/muhlba91/pulumi-proxmoxve/sdk/v8/go/proxmoxve"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Replication
    		_, err := proxmoxve.NewReplicationLegacy(ctx, "example_replication_1", &proxmoxve.ReplicationLegacyArgs{
    			ResourceId: pulumi.String("100-0"),
    			Target:     pulumi.String("pve-02"),
    			Type:       pulumi.String("local"),
    			Disable:    pulumi.Bool(false),
    			Comment:    pulumi.String("Replication to pve-02 every 30 min"),
    			Schedule:   pulumi.String("*/30"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using ProxmoxVE = Pulumi.ProxmoxVE;
    
    return await Deployment.RunAsync(() => 
    {
        // Replication
        var exampleReplication1 = new ProxmoxVE.Index.ReplicationLegacy("example_replication_1", new()
        {
            ResourceId = "100-0",
            Target = "pve-02",
            Type = "local",
            Disable = false,
            Comment = "Replication to pve-02 every 30 min",
            Schedule = "*/30",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import io.muehlbachler.pulumi.proxmoxve.ReplicationLegacy;
    import io.muehlbachler.pulumi.proxmoxve.ReplicationLegacyArgs;
    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) {
            // Replication
            var exampleReplication1 = new ReplicationLegacy("exampleReplication1", ReplicationLegacyArgs.builder()
                .resourceId("100-0")
                .target("pve-02")
                .type("local")
                .disable(false)
                .comment("Replication to pve-02 every 30 min")
                .schedule("*/30")
                .build());
    
        }
    }
    
    resources:
      # Replication
      exampleReplication1:
        type: proxmoxve:ReplicationLegacy
        name: example_replication_1
        properties:
          resourceId: 100-0
          target: pve-02
          type: local
          disable: false
          comment: Replication to pve-02 every 30 min
          schedule: '*/30'
    

    Create ReplicationLegacy Resource

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

    Constructor syntax

    new ReplicationLegacy(name: string, args: ReplicationLegacyArgs, opts?: CustomResourceOptions);
    @overload
    def ReplicationLegacy(resource_name: str,
                          args: ReplicationLegacyArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def ReplicationLegacy(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          resource_id: Optional[str] = None,
                          target: Optional[str] = None,
                          type: Optional[str] = None,
                          comment: Optional[str] = None,
                          disable: Optional[bool] = None,
                          rate: Optional[float] = None,
                          schedule: Optional[str] = None)
    func NewReplicationLegacy(ctx *Context, name string, args ReplicationLegacyArgs, opts ...ResourceOption) (*ReplicationLegacy, error)
    public ReplicationLegacy(string name, ReplicationLegacyArgs args, CustomResourceOptions? opts = null)
    public ReplicationLegacy(String name, ReplicationLegacyArgs args)
    public ReplicationLegacy(String name, ReplicationLegacyArgs args, CustomResourceOptions options)
    
    type: proxmoxve:ReplicationLegacy
    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 ReplicationLegacyArgs
    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 ReplicationLegacyArgs
    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 ReplicationLegacyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReplicationLegacyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReplicationLegacyArgs
    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 replicationLegacyResource = new ProxmoxVE.ReplicationLegacy("replicationLegacyResource", new()
    {
        ResourceId = "string",
        Target = "string",
        Type = "string",
        Comment = "string",
        Disable = false,
        Rate = 0,
        Schedule = "string",
    });
    
    example, err := proxmoxve.NewReplicationLegacy(ctx, "replicationLegacyResource", &proxmoxve.ReplicationLegacyArgs{
    	ResourceId: pulumi.String("string"),
    	Target:     pulumi.String("string"),
    	Type:       pulumi.String("string"),
    	Comment:    pulumi.String("string"),
    	Disable:    pulumi.Bool(false),
    	Rate:       pulumi.Float64(0),
    	Schedule:   pulumi.String("string"),
    })
    
    var replicationLegacyResource = new ReplicationLegacy("replicationLegacyResource", ReplicationLegacyArgs.builder()
        .resourceId("string")
        .target("string")
        .type("string")
        .comment("string")
        .disable(false)
        .rate(0.0)
        .schedule("string")
        .build());
    
    replication_legacy_resource = proxmoxve.ReplicationLegacy("replicationLegacyResource",
        resource_id="string",
        target="string",
        type="string",
        comment="string",
        disable=False,
        rate=float(0),
        schedule="string")
    
    const replicationLegacyResource = new proxmoxve.ReplicationLegacy("replicationLegacyResource", {
        resourceId: "string",
        target: "string",
        type: "string",
        comment: "string",
        disable: false,
        rate: 0,
        schedule: "string",
    });
    
    type: proxmoxve:ReplicationLegacy
    properties:
        comment: string
        disable: false
        rate: 0
        resourceId: string
        schedule: string
        target: string
        type: string
    

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

    ResourceId string
    Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '\n\n-\n\n'.
    Target string
    Target node.
    Type string
    Section type.
    Comment string
    Description.
    Disable bool
    Flag to disable/deactivate this replication.
    Rate double
    Rate limit in mbps (megabytes per second) as floating point number.
    Schedule string
    Storage replication schedule. The format is a subset of systemd calendar events. Defaults to */15
    ResourceId string
    Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '\n\n-\n\n'.
    Target string
    Target node.
    Type string
    Section type.
    Comment string
    Description.
    Disable bool
    Flag to disable/deactivate this replication.
    Rate float64
    Rate limit in mbps (megabytes per second) as floating point number.
    Schedule string
    Storage replication schedule. The format is a subset of systemd calendar events. Defaults to */15
    resourceId String
    Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '\n\n-\n\n'.
    target String
    Target node.
    type String
    Section type.
    comment String
    Description.
    disable Boolean
    Flag to disable/deactivate this replication.
    rate Double
    Rate limit in mbps (megabytes per second) as floating point number.
    schedule String
    Storage replication schedule. The format is a subset of systemd calendar events. Defaults to */15
    resourceId string
    Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '\n\n-\n\n'.
    target string
    Target node.
    type string
    Section type.
    comment string
    Description.
    disable boolean
    Flag to disable/deactivate this replication.
    rate number
    Rate limit in mbps (megabytes per second) as floating point number.
    schedule string
    Storage replication schedule. The format is a subset of systemd calendar events. Defaults to */15
    resource_id str
    Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '\n\n-\n\n'.
    target str
    Target node.
    type str
    Section type.
    comment str
    Description.
    disable bool
    Flag to disable/deactivate this replication.
    rate float
    Rate limit in mbps (megabytes per second) as floating point number.
    schedule str
    Storage replication schedule. The format is a subset of systemd calendar events. Defaults to */15
    resourceId String
    Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '\n\n-\n\n'.
    target String
    Target node.
    type String
    Section type.
    comment String
    Description.
    disable Boolean
    Flag to disable/deactivate this replication.
    rate Number
    Rate limit in mbps (megabytes per second) as floating point number.
    schedule String
    Storage replication schedule. The format is a subset of systemd calendar events. Defaults to */15

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ReplicationLegacy resource produces the following output properties:

    Guest int
    Guest ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    Jobnum int
    Unique, sequential ID assigned to each job.
    Source string
    For internal use, to detect if the guest was stolen.
    Guest int
    Guest ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    Jobnum int
    Unique, sequential ID assigned to each job.
    Source string
    For internal use, to detect if the guest was stolen.
    guest Integer
    Guest ID.
    id String
    The provider-assigned unique ID for this managed resource.
    jobnum Integer
    Unique, sequential ID assigned to each job.
    source String
    For internal use, to detect if the guest was stolen.
    guest number
    Guest ID.
    id string
    The provider-assigned unique ID for this managed resource.
    jobnum number
    Unique, sequential ID assigned to each job.
    source string
    For internal use, to detect if the guest was stolen.
    guest int
    Guest ID.
    id str
    The provider-assigned unique ID for this managed resource.
    jobnum int
    Unique, sequential ID assigned to each job.
    source str
    For internal use, to detect if the guest was stolen.
    guest Number
    Guest ID.
    id String
    The provider-assigned unique ID for this managed resource.
    jobnum Number
    Unique, sequential ID assigned to each job.
    source String
    For internal use, to detect if the guest was stolen.

    Look up Existing ReplicationLegacy Resource

    Get an existing ReplicationLegacy 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?: ReplicationLegacyState, opts?: CustomResourceOptions): ReplicationLegacy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            comment: Optional[str] = None,
            disable: Optional[bool] = None,
            guest: Optional[int] = None,
            jobnum: Optional[int] = None,
            rate: Optional[float] = None,
            resource_id: Optional[str] = None,
            schedule: Optional[str] = None,
            source: Optional[str] = None,
            target: Optional[str] = None,
            type: Optional[str] = None) -> ReplicationLegacy
    func GetReplicationLegacy(ctx *Context, name string, id IDInput, state *ReplicationLegacyState, opts ...ResourceOption) (*ReplicationLegacy, error)
    public static ReplicationLegacy Get(string name, Input<string> id, ReplicationLegacyState? state, CustomResourceOptions? opts = null)
    public static ReplicationLegacy get(String name, Output<String> id, ReplicationLegacyState state, CustomResourceOptions options)
    resources:  _:    type: proxmoxve:ReplicationLegacy    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:
    Comment string
    Description.
    Disable bool
    Flag to disable/deactivate this replication.
    Guest int
    Guest ID.
    Jobnum int
    Unique, sequential ID assigned to each job.
    Rate double
    Rate limit in mbps (megabytes per second) as floating point number.
    ResourceId string
    Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '\n\n-\n\n'.
    Schedule string
    Storage replication schedule. The format is a subset of systemd calendar events. Defaults to */15
    Source string
    For internal use, to detect if the guest was stolen.
    Target string
    Target node.
    Type string
    Section type.
    Comment string
    Description.
    Disable bool
    Flag to disable/deactivate this replication.
    Guest int
    Guest ID.
    Jobnum int
    Unique, sequential ID assigned to each job.
    Rate float64
    Rate limit in mbps (megabytes per second) as floating point number.
    ResourceId string
    Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '\n\n-\n\n'.
    Schedule string
    Storage replication schedule. The format is a subset of systemd calendar events. Defaults to */15
    Source string
    For internal use, to detect if the guest was stolen.
    Target string
    Target node.
    Type string
    Section type.
    comment String
    Description.
    disable Boolean
    Flag to disable/deactivate this replication.
    guest Integer
    Guest ID.
    jobnum Integer
    Unique, sequential ID assigned to each job.
    rate Double
    Rate limit in mbps (megabytes per second) as floating point number.
    resourceId String
    Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '\n\n-\n\n'.
    schedule String
    Storage replication schedule. The format is a subset of systemd calendar events. Defaults to */15
    source String
    For internal use, to detect if the guest was stolen.
    target String
    Target node.
    type String
    Section type.
    comment string
    Description.
    disable boolean
    Flag to disable/deactivate this replication.
    guest number
    Guest ID.
    jobnum number
    Unique, sequential ID assigned to each job.
    rate number
    Rate limit in mbps (megabytes per second) as floating point number.
    resourceId string
    Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '\n\n-\n\n'.
    schedule string
    Storage replication schedule. The format is a subset of systemd calendar events. Defaults to */15
    source string
    For internal use, to detect if the guest was stolen.
    target string
    Target node.
    type string
    Section type.
    comment str
    Description.
    disable bool
    Flag to disable/deactivate this replication.
    guest int
    Guest ID.
    jobnum int
    Unique, sequential ID assigned to each job.
    rate float
    Rate limit in mbps (megabytes per second) as floating point number.
    resource_id str
    Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '\n\n-\n\n'.
    schedule str
    Storage replication schedule. The format is a subset of systemd calendar events. Defaults to */15
    source str
    For internal use, to detect if the guest was stolen.
    target str
    Target node.
    type str
    Section type.
    comment String
    Description.
    disable Boolean
    Flag to disable/deactivate this replication.
    guest Number
    Guest ID.
    jobnum Number
    Unique, sequential ID assigned to each job.
    rate Number
    Rate limit in mbps (megabytes per second) as floating point number.
    resourceId String
    Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '\n\n-\n\n'.
    schedule String
    Storage replication schedule. The format is a subset of systemd calendar events. Defaults to */15
    source String
    For internal use, to detect if the guest was stolen.
    target String
    Target node.
    type String
    Section type.

    Package Details

    Repository
    proxmoxve muhlba91/pulumi-proxmoxve
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the proxmox Terraform Provider.
    proxmoxve logo
    Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.1.0
    published on Sunday, Apr 26, 2026 by Daniel Muehlbachler-Pietrzykowski
      Try Pulumi Cloud free. Your team will thank you.