1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. getReplication
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
Schema (JSON)
muhlba91/pulumi-proxmoxve

proxmoxve.getReplication

proxmoxve logo
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
Schema (JSON)
muhlba91/pulumi-proxmoxve

    Retrieves information about an existing Replication.

    Using getReplication

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getReplication(args: GetReplicationArgs, opts?: InvokeOptions): Promise<GetReplicationResult>
function getReplicationOutput(args: GetReplicationOutputArgs, opts?: InvokeOptions): Output<GetReplicationResult>
    def get_replication(id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetReplicationResult
def get_replication_output(id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetReplicationResult]
    func LookupReplication(ctx *Context, args *LookupReplicationArgs, opts ...InvokeOption) (*LookupReplicationResult, error)
func LookupReplicationOutput(ctx *Context, args *LookupReplicationOutputArgs, opts ...InvokeOption) LookupReplicationResultOutput

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

    public static class GetReplication 
{
    public static Task<GetReplicationResult> InvokeAsync(GetReplicationArgs args, InvokeOptions? opts = null)
    public static Output<GetReplicationResult> Invoke(GetReplicationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetReplicationResult> getReplication(GetReplicationArgs args, InvokeOptions options)
public static Output<GetReplicationResult> getReplication(GetReplicationArgs args, InvokeOptions options)

    fn::invoke:
  function: proxmoxve:index/getReplication:getReplication
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id 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'.
    Id 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'.
    id 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'.
    id 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'.
    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'.
    id 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'.

    getReplication Result

    The following output properties are available:

    Comment string
    Description.
    Disable bool
    Flag to disable/deactivate this replication.
    Guest int
    Guest ID.
    Id 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'.
    Jobnum int
    Unique, sequential ID assigned to each job.
    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
    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.
    Id 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'.
    Jobnum int
    Unique, sequential ID assigned to each job.
    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
    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.
    id 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'.
    jobnum Integer
    Unique, sequential ID assigned to each job.
    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
    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.
    id 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'.
    jobnum number
    Unique, sequential ID assigned to each job.
    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
    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.
    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'.
    jobnum int
    Unique, sequential ID assigned to each job.
    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
    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.
    id 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'.
    jobnum Number
    Unique, sequential ID assigned to each job.
    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
    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.0.0
    published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
    Schema (JSON)
    muhlba91/pulumi-proxmoxve
      Try Pulumi Cloud free. Your team will thank you.