Package org.ovirt.engine.sdk4.services

Interface HostService.InstallRequest

All Superinterfaces:

Request<HostService.InstallRequest,HostService.InstallResponse>

Enclosing interface:

HostService

public static interface HostService.InstallRequest
extends Request<HostService.InstallRequest,HostService.InstallResponse>

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: [source,bash] ---- 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: [source,bash] ---- 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.

Method Summary

Modifier and Type	Method	Description
HostService.InstallRequest	activate(Boolean activate)	When set to 'true', this host will be activated after its installation completes.
HostService.InstallRequest	async(Boolean async)	Indicates if the installation should be performed asynchronously.
HostService.InstallRequest	deployHostedEngine(Boolean deployHostedEngine)	When set to `true` this host will also deploy the self-hosted engine components.
HostService.InstallRequest	host(HostBuilder host)	The `override_iptables` property is used to indicate if the firewall configuration should be replaced by the default one.
HostService.InstallRequest	host(Host host)
HostService.InstallRequest	image(String image)	When installing {hypervisor-name}, an ISO image file is required.
HostService.InstallRequest	reboot(Boolean reboot)	Indicates if the host should be rebooted after successful installation.
HostService.InstallRequest	rootPassword(String rootPassword)	The password of the `root` user used to connect to the host via SSH.
HostService.InstallRequest	ssh(SshBuilder ssh)	The SSH details used to connect to the host.
HostService.InstallRequest	ssh(Ssh ssh)
HostService.InstallRequest	undeployHostedEngine(Boolean undeployHostedEngine)	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.

Methods inherited from interface org.ovirt.engine.sdk4.Request

header, query, send

Method Detail

activate

HostService.InstallRequest activate(Boolean activate)

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

HostService.InstallRequest async(Boolean async)

Indicates if the installation should be performed asynchronously.

deployHostedEngine

HostService.InstallRequest deployHostedEngine(Boolean deployHostedEngine)

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

HostService.InstallRequest host(Host host)

host

HostService.InstallRequest host(HostBuilder host)

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

image

HostService.InstallRequest image(String image)

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

reboot

HostService.InstallRequest reboot(Boolean reboot)

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

rootPassword

HostService.InstallRequest rootPassword(String rootPassword)

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

ssh

HostService.InstallRequest ssh(Ssh ssh)

ssh

HostService.InstallRequest ssh(SshBuilder ssh)

The SSH details used to connect to the host.

undeployHostedEngine

HostService.InstallRequest undeployHostedEngine(Boolean undeployHostedEngine)

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.