Class: OvirtSDK4::HostsService
- Defined in:
- lib/ovirtsdk4/services.rb,
lib/ovirtsdk4/services.rb
Instance Method Summary collapse
-
#add(host, opts = {}) ⇒ Host
Creates a new host.
-
#add_using_root_password(host, opts = {}) ⇒ Host
Add a new host to the system providing the host root password.
-
#add_using_ssh(host, opts = {}) ⇒ Host
Add a new host to the system providing the ssh password or fingerprint.
-
#host_service(id) ⇒ HostService
A Reference to service managing a specific host.
-
#list(opts = {}) ⇒ Array<Host>
Get a list of all available hosts.
-
#service(path) ⇒ Service
Locates the service corresponding to the given path.
Methods inherited from Service
Instance Method Details
#add(host, opts = {}) ⇒ Host
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:
POST /ovirt-engine/api/hosts
With the following request body:
<host>
<name>myhost</name>
<address>myhost.example.com</address>
<root_password>myrootpassword</root_password>
</host>
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 we override the host firewall definitions by default. |
To add a hosted engine host, use the optional deploy_hosted_engine
parameter:
POST /ovirt-engine/api/hosts?deploy_hosted_engine=true
If the cluster has a default external network provider which 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 that differs to what is defined in the clusters, overwrite the external network provider when adding hosts by sending a request like this:
POST /ovirt-engine/api/hosts
With a request body that contains a reference to the desired provider in the
external_network_provider_configuration
:
<host>
<name>myhost</name>
<address>myhost.example.com</address>
<root_password>123456</root_password>
<external_network_provider_configurations>
<external_network_provider_configuration>
<external_network_provider name="ovirt-provider-ovn"/>
</external_network_provider_configuration>
</external_network_provider_configurations>
</host>
11490 11491 11492 |
# File 'lib/ovirtsdk4/services.rb', line 11490 def add(host, opts = {}) internal_add(host, Host, ADD, opts) end |
#add_using_root_password(host, opts = {}) ⇒ Host
Add a new host to the system providing the host root password. This has been deprecated and provided for backwards compatibility.
11612 11613 11614 |
# File 'lib/ovirtsdk4/services.rb', line 11612 def add_using_root_password(host, opts = {}) internal_add(host, Host, ADD_USING_ROOT_PASSWORD, opts) end |
#add_using_ssh(host, opts = {}) ⇒ Host
Add a new host to the system providing the ssh password or fingerprint.
11650 11651 11652 |
# File 'lib/ovirtsdk4/services.rb', line 11650 def add_using_ssh(host, opts = {}) internal_add(host, Host, ADD_USING_SSH, opts) end |
#host_service(id) ⇒ HostService
A Reference to service managing a specific host.
11661 11662 11663 |
# File 'lib/ovirtsdk4/services.rb', line 11661 def host_service(id) HostService.new(self, id) end |
#list(opts = {}) ⇒ Array<Host>
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 something like this:
<hosts>
<host href="/ovirt-engine/api/hosts/123" id="123">
...
</host>
<host href="/ovirt-engine/api/hosts/456" id="456">
...
</host>
...
</host>
The order of the returned list of hosts is guaranteed only if the sortby
clause is included in
the search
parameter.
11574 11575 11576 |
# File 'lib/ovirtsdk4/services.rb', line 11574 def list(opts = {}) internal_get(LIST, opts) end |
#service(path) ⇒ Service
Locates the service corresponding to the given path.
11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 |
# File 'lib/ovirtsdk4/services.rb', line 11672 def service(path) if path.nil? || path == '' return self end index = path.index('/') if index.nil? return host_service(path) end return host_service(path[0..(index - 1)]).service(path[(index +1)..-1]) end |