The run command starts a Capture Process or an Apply Process, all the processes of one kind, or all the processes. Without parameters it starts every process that is not running. The parameters process and id, the states in which a process accepts the command and the HTTP codes are explained on PROCESS CONTROL COMMANDS.
repcli run [process=capture|apply [id=processID]]| Parameter | Description |
|---|---|
| process | capture for the Capture Processes, apply for the Apply Processes. Without it the command is sent to all the processes. |
| id | The identifier of the process. It needs process. Without it the command is sent to all the processes of that kind. |
repcli prints a line for every process the command is meant for: the status in brackets and the message.
| Status | Meaning |
|---|---|
| In Process | The command has been sent to the process. The process starts a moment later, use the status command to monitor it. |
| Failed | The command has not been sent. The message tells why: the process is running already (Command [RUN] is not valid for this status), the id does not exist, or a parameter is wrong (see the messages on PROCESS CONTROL COMMANDS). |
Run all the processes. The Capture Process 1 and the Apply Process 1 were stopped:
repcli run
[In Process]: Command [RUN] has been sent. Use [status] command to monitor the Capture 1 process
[In Process]: Command [RUN] has been sent. Use [status] command to monitor the Apply 1 processRun the same command again while the processes are running. Nothing is sent, and each process says why:
repcli run
[Failed]: Capture 1 Process status is [In Process]. Command [RUN] is not valid for this status
[Failed]: Apply 1 Process status is [In Process]. Command [RUN] is not valid for this statusRun one process:
repcli run process=capture id=1
[In Process]: Command [RUN] has been sent. Use [status] command to monitor the Capture 1 processA process that does not exist:
repcli run process=capture id=9
[Failed]: Process id=9 does not existA process that has failed can be run again after the cause has been removed. Repstance also runs a failed process again by itself, see Stop/Run Replication Processes.
The body of the request. The element parameters is optional: without it the command is sent to all the processes. The pairs are in the same order as in repcli, process first and then id:
{
"command": "run",
"parameters": [
["process", "capture"],
["id", "1"]
]
}The body of the answer is an array with an element for every process the command is meant for. The element names the process in its message:
[
{
"command": "RUN",
"status": "In Process",
"message": "Command [RUN] has been sent. Use [status] command to monitor the Capture 1 process"
}
]| HTTP code | Meaning |
|---|---|
| 200 | The request is valid. The body has an element for every process the command is meant for, with the status In Process or Failed. |
| 401 | The token is invalid. |
| 422 | The request is invalid: the JSON, the command, a parameter, or the process does not exist. The body has one element with the status Failed and the message. |
Click “Run All Processes” on the dashboard to run all the processes, or “Run” on the card of a process to run that process. Both ask for a confirmation. The buttons, the confirmations and the state of the cards are shown in Stop/Run Replication Processes.
Prev page:
PROCESS CONTROL COMMANDSNext page:
Stop any Capture or Apply Processes