All Superinterfaces:

Service

All Known Implementing Classes:

HostsServiceImpl
```
public interface HostsService
extends Service
```
A service that manages hosts.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`HostsService.AddRequest`	Creates a new host.
`static interface`	`HostsService.AddResponse`	Creates a new host.
`static interface`	`HostsService.AddUsingRootPasswordRequest`	Add a new host to the system providing the host root password.
`static interface`	`HostsService.AddUsingRootPasswordResponse`	Add a new host to the system providing the host root password.
`static interface`	`HostsService.AddUsingSshRequest`	Add a new host to the system providing the ssh password, fingerprint or public key.
`static interface`	`HostsService.AddUsingSshResponse`	Add a new host to the system providing the ssh password, fingerprint or public key.
`static interface`	`HostsService.ListRequest`	Get a list of all available hosts.
`static interface`	`HostsService.ListResponse`	Get a list of all available hosts.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`HostsService.AddRequest`	`add()`	Creates a new host.
`HostsService.AddUsingRootPasswordRequest`	`addUsingRootPassword()`	Add a new host to the system providing the host root password.
`HostsService.AddUsingSshRequest`	`addUsingSsh()`	Add a new host to the system providing the ssh password, fingerprint or public key.
`HostService`	`hostService(String id)`	A Reference to service managing a specific host.
`HostsService.ListRequest`	`list()`	Get a list of all available hosts.
`Service`	`service(String path)`	Service locator method, returns individual service on which the URI is dispatched.

- Method Detail
  - add
```
HostsService.AddRequest add()
```
    Creates a new host. The host is created based on the attributes of the `host` parameter. The `name`, `address`, and `root_password` properties are required. For example, to add a host, send the following request: [source] ---- POST /ovirt-engine/api/hosts ---- With the following request body: [source,xml] ---- myhost
    myhost.example.com
    myrootpassword ---- NOTE: The `root_password` element is only included in the client-provided initial representation and is not exposed in the representations returned from subsequent requests. IMPORTANT: Since version 4.1.2 of the engine, when a host is newly added, the host's firewall definitions are overridden by default. To add a hosted engine host, use the optional `deploy_hosted_engine` parameter: [source] ---- POST /ovirt-engine/api/hosts?deploy_hosted_engine=true ---- If the cluster has a default external network provider that is supported for automatic deployment, the external network provider is deployed when adding the host. Only external network providers for OVN are supported for the automatic deployment. To deploy an external network provider other than the one defined in the clusters, overwrite the external network provider when adding hosts, by sending the following request: [source] ---- POST /ovirt-engine/api/hosts ---- With a request body that contains a reference to the desired provider in the `external_network_provider_configuration`: [source,xml] ---- myhost
    myhost.example.com
    123456 ----
  - list
```
HostsService.ListRequest list()
```
    Get a list of all available hosts. For example, to list the hosts send the following request: .... GET /ovirt-engine/api/hosts .... The response body will be similar to this: [source,xml] ---- ... ... ... ---- The order of the returned list of hosts is guaranteed only if the `sortby` clause is included in the `search` parameter.
  - addUsingRootPassword
```
HostsService.AddUsingRootPasswordRequest addUsingRootPassword()
```
    Add a new host to the system providing the host root password. This has been deprecated and provided for backwards compatibility.
  - addUsingSsh
```
HostsService.AddUsingSshRequest addUsingSsh()
```
    Add a new host to the system providing the ssh password, fingerprint or public key.
  - hostService
```
HostService hostService(String id)
```
    A Reference to service managing a specific host.
  - service
```
Service service(String path)
```
    Service locator method, returns individual service on which the URI is dispatched.

Interface HostsService

Nested Class Summary

Method Summary

Method Detail

add

list

addUsingRootPassword

addUsingSsh

hostService

service