nodes / replication
5 operations.
GET /nodes/{node}/replication
ts
proxmox.nodes.$(node).replication.$get()List status of all replication jobs on this node.
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
guest | number | Only list replication jobs for this guest. — format pve-vmid, min 100, max 999999999 | |
node | string | yes | The cluster node name. — format pve-node |
GET /nodes/{node}/replication/{id}
ts
proxmox.nodes.$(node).replication.$(id).$get()Directory index.
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | yes | Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. — format pve-replication-job-id |
node | string | yes | The cluster node name. — format pve-node |
GET /nodes/{node}/replication/{id}/log
ts
proxmox.nodes.$(node).replication.$(id).log.$get()Read replication job log.
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | yes | Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. — format pve-replication-job-id |
limit | number | min 0 | |
node | string | yes | The cluster node name. — format pve-node |
start | number | min 0 |
POST /nodes/{node}/replication/{id}/schedule_now
ts
proxmox.nodes.$(node).replication.$(id).schedule_now.$post()Schedule replication job to start as soon as possible.
Returns string.
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | yes | Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. — format pve-replication-job-id |
node | string | yes | The cluster node name. — format pve-node |
GET /nodes/{node}/replication/{id}/status
ts
proxmox.nodes.$(node).replication.$(id).status.$get()Get replication job status.
Returns object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | yes | Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. — format pve-replication-job-id |
node | string | yes | The cluster node name. — format pve-node |