Method: OvirtSDK4::HostService#install

Defined in:

lib/ovirtsdk4/services.rb

#install(opts = {}) ⇒ Object

Installs the latest version of VDSM and related software on the host.

The action also performs every configuration steps on the host which is done during adding host to the engine: kdump configuration, hosted-engine deploy, kernel options changes, etc.

The host type defines additional parameters for the action.

Example of installing a host, using curl and JSON, plain:

curl \
--verbose \
--cacert /etc/pki/ovirt-engine/ca.pem \
--request PUT \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Version: 4" \
--user "admin@internal:..." \
--data '
{
  "root_password": "myrootpassword"
}
' \
"https://engine.example.com/ovirt-engine/api/hosts/123"

Example of installing a host using curl and JSON with hosted engine components:

curl \
curl \
--verbose \
--cacert /etc/pki/ovirt-engine/ca.pem \
--request PUT \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Version: 4" \
--user "admin@internal:..." \
--data '
{
  "root_password": "myrootpassword"
"deploy_hosted_engine" : "true"
}
' \
"https://engine.example.com/ovirt-engine/api/hosts/123"

Important

Since version 4.1.2 of the engine, when a host is reinstalled we override the host firewall definitions by default.

Parameters:

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

  Additional options.

Options Hash (opts):

• :activate (Boolean) —

  When set to 'true', this host will be activated after its installation completes. When set to 'false' the host will remain in 'maintenance' status after its installation. Absence of this parameter will be interpreted as 'true', since the desired default behavior is activating the host after install.

• :async (Boolean) —

  Indicates if the installation should be performed asynchronously.

• :deploy_hosted_engine (Boolean) —

  When set to true this host will also deploy the self-hosted engine components. A missing value is treated as true i.e deploy. Omitting this parameter means false and will not perform any operation in the self-hosted engine area.

• :host (Host) —

  The override_iptables property is used to indicate if the firewall configuration should be replaced by the default one.

• :image (String) —

  When installing hypervisor-name, an ISO image file is required.

• :reboot (Boolean) —

  Indicates if the host should be rebooted after successful installation. The default value is true.

• :root_password (String) —

  The password of the root user used to connect to the host via SSH.

• :ssh (Ssh) —

  The SSH details used to connect to the host.

• :undeploy_hosted_engine (Boolean) —

  When set to true this host will un-deploy the self-hosted engine components, and this host will not function as part of the High Availability cluster. A missing value is treated as true i.e un-deploy. Omitting this parameter means false and will not perform any operation in the self-hosted engine area.

• :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.

# File 'lib/ovirtsdk4/services.rb', line 38774

def install(opts = {})
  internal_action(:install, nil, INSTALL, opts)
end