Method: OvirtSDK4::VmService#start

Defined in:
lib/ovirtsdk4/services.rb

#start(opts = {}) ⇒ Object

Starts the virtual machine.

If the virtual environment is complete and the virtual machine contains all necessary components to function, it can be started.

This example starts the virtual machine:

POST /ovirt-engine/api/vms/123/start

With a request body:

<action/>

Parameters:

  • opts (Hash) (defaults to: {})

    Additional options.

Options Hash (opts):

  • :async (Boolean)

    Indicates if the start action should be performed asynchronously.

  • :authorized_key (AuthorizedKey)
  • :filter (Boolean)

    Indicates if the results should be filtered according to the permissions of the user.

  • :pause (Boolean)

    If set to true, start the virtual machine in paused mode. The default is false.

  • :use_cloud_init (Boolean)

    If set to true, the initialization type is set to cloud-init. The default value is false. See this for details.

  • :use_ignition (Boolean)

    If set to true, the initialization type is set to Ignition. The default value is false. See this for details.

  • :use_initialization (Boolean)

    If set to true, the initialization type is set by the VM’s OS. Windows will set to Sysprep, Linux to cloud-init and RedHat CoreOS to Ignition. If any of the initialization-types are explicitly set (useCloudInit, useSysprep or useIgnition), they will be prioritized and this flag will be ignored. The default value is false.

  • :use_sysprep (Boolean)

    If set to true, the initialization type is set to Sysprep. The default value is false. See this for details.

  • :vm (Vm)

    The definition of the virtual machine for this specific run.

    For example:

    <action>
      <vm>
        <os>
          <boot>
            <devices>
              <device>cdrom</device>
            </devices>
          </boot>
        </os>
      </vm>
    </action>

    This will set the boot device to the CDROM only for this specific start. After the virtual machine is powered off, this definition will be reverted.

  • :volatile (Boolean)

    Indicates that this run configuration will be discarded even in the case of guest-initiated reboot. The default value is false.

  • :headers (Hash) — default: {}

    Additional HTTP headers.

  • :query (Hash) — default: {}

    Additional URL query parameters.

  • :timeout (Integer) — default: nil

    The timeout for this request, in seconds. If no value is explicitly given then the timeout set globally for the connection will be used.

  • :wait (Boolean) — default: true

    If true wait for the response.


30681
30682
30683
# File 'lib/ovirtsdk4/services.rb', line 30681

def start(opts = {})
  internal_action(:start, nil, START, opts)
end