Start a KVM virtual machine on a target

POST api/v2/jobs/rvc '{"method":"kvm.start","params":{"hostname":"<kvm_hostname>"},"hostnames":["<node_hostname>"]}'

Starts a SC//Reliant™ Virtual Controller (RVC) job to start a KVM virtual machine on one or more targets. The available targets are a node, node group, or saved filter. The response will indicate that the RVC job is created and is scheduled to run. You can use the job ID from the response to retrieve the job status and the payload.

For a cluster-managed virtual machine, RVC puts the cluster in maintenance mode during the operation, waits for the cluster to refresh the virtual machine resource, and then takes the cluster out of maintenance mode before the operation ends.

Note: This method runs in the background. The job finishes as soon as the operation starts, and its payload only confirms that the operation was started. To confirm that the operation completed, run kvm.status until it returns running, and then wait until rvc.busy returns an empty list. The virtual machine can report running before the start operation has finished, and other operations on the virtual machine fail until it finishes. For more information, see Troubleshooting RVC jobs.

In order to perform this action, the following conditions must be met:

• Must have the Remote Job Execution feature turned on at the site level.
• The user must have the following capabilities:
  • Create and Update a RVC job
  • Call KVM state altering methods

Request syntax

post api/v2/jobs/rvc '{"method":"kvm.start","params":{"hostname":"<kvm_hostname>"},"hostnames":["<node_hostname>"]}'

Request parameters

The request accepts the following data in JSON format.

Method parameters

The params object accepts the following parameters.

Response syntax

When the hostnames request parameter is used, the following response syntax is received.

{
    "id": integer,
    "type": "RVC3",
    "status": "string",
    "message": "string",
    "trigged_by": "string",
    "parameters": {
        "method": "kvm.start",
        "params": {
            "hostname": "<kvm_hostname>"
        },
        "update_rpm": boolean,
        "hostnames": [
            "string"
        ]
    },
    "time_started": "timestamp"
}

Response parameters

If the action is successful, an HTTP 200 response is returned. The following data is returned in JSON format.

Errors

The following errors can be returned for a node in the job payload. For other errors, see Troubleshooting RVC jobs and Common errors.

Examples

Example 1: Start a KVM virtual machine on a node.

This example starts the KVM virtual machine kvm1 on the node with hostname sit0001red0.

ruby api.rb <customer_code> POST api/v2/jobs/rvc '{"method":"kvm.start","params":{"hostname":"kvm1"},"hostnames":["sit0001red0"]}'

Response

{
  "id": 1782002,
  "type": "RVC3",
  "status": "pending",
  "message": null,
  "trigged_by": "test.user",
  "parameters": {
    "method": "kvm.start",
    "params": {
      "hostname": "kvm1"
    },
    "update_rpm": true,
    "hostnames": [
      "sit0001red0"
    ]
  },
  "time_started": "2026-10-11T21:45:59Z"
}

Example 2: Retrieving the payload from the RVC job.

This example retrieves the payload from RVC job ID 1782002.

ruby api.rb <customer_code> GET "api/jobs/1782002?include_payload=true"

Response

{
  "id": 1782002,
  "type": "RVC3",
  "status": "finished",
  "message": null,
  "trigged_by": "test.user",
  "success_nodes_count": 1,
  "failed_nodes_count": 0,
  "total_nodes_count": 1,
  "parameters": {
    "method": "kvm.start",
    "params": {
      "hostname": "kvm1"
    },
    "hostnames": [
      "sit0001red0"
    ],
    "update_rpm": true
  },
  "time_started": "2026-10-11T21:45:59Z",
  "time_finished": "2026-10-11T21:46:00Z",
  "payload": {
    "sit0001red0": [
      {
        "result": "Starting kvm1...",
        "timestamp": 1791755161
      }
    ]
  }
}