Package org.ovirt.engine.sdk4.services

Interface HostService.InstallUsingSshRequest

All Superinterfaces:

Request<HostService.InstallUsingSshRequest,HostService.InstallUsingSshResponse>

Enclosing interface:

HostService

public static interface HostService.InstallUsingSshRequest
extends Request<HostService.InstallUsingSshRequest,HostService.InstallUsingSshResponse>

Install VDSM and other packages required to get the host ready to be used in the engine providing the SSH password.

Method Summary

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

Indicates if the installation should be performed asynchronously.

deployHostedEngine

HostService.InstallUsingSshRequest 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.InstallUsingSshRequest host(Host host)

host

HostService.InstallUsingSshRequest host(HostBuilder host)

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

image

HostService.InstallUsingSshRequest image(String image)

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

reboot

HostService.InstallUsingSshRequest reboot(Boolean reboot)

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

rootPassword

HostService.InstallUsingSshRequest rootPassword(String rootPassword)

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

ssh

HostService.InstallUsingSshRequest ssh(Ssh ssh)

ssh

HostService.InstallUsingSshRequest ssh(SshBuilder ssh)

The SSH details used to connect to the host.

undeployHostedEngine

HostService.InstallUsingSshRequest 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.