services.HostService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of model Show documentation
Show all versions of model Show documentation
Model management tools for the oVirt Engine API.
/*
Copyright (c) 2015 Red Hat, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package services;
import annotations.Area;
import mixins.Follow;
import org.ovirt.api.metamodel.annotations.In;
import org.ovirt.api.metamodel.annotations.InputDetail;
import org.ovirt.api.metamodel.annotations.Out;
import org.ovirt.api.metamodel.annotations.Service;
import services.externalhostproviders.KatelloErrataService;
import types.Cluster;
import types.Host;
import types.HostNic;
import types.IscsiDetails;
import types.NetworkAttachment;
import types.NetworkLabel;
import types.PowerManagement;
import types.Ssh;
import types.StorageDomain;
import static org.ovirt.api.metamodel.language.ApiLanguage.COLLECTION;
import static org.ovirt.api.metamodel.language.ApiLanguage.mandatory;
import static org.ovirt.api.metamodel.language.ApiLanguage.optional;
import static org.ovirt.api.metamodel.language.ApiLanguage.or;
/**
* A service to manage a host.
*
* @author Yaniv Bronheim
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@Service
@Area("Infrastructure")
public interface HostService extends MeasurableService {
/**
* Activates the host for use, for example to run virtual machines.
*
* @author Oved Ourfali
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
interface Activate {
/**
* Indicates if the activation should be performed asynchronously.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Boolean async();
}
/**
* Approve a pre-installed Hypervisor host for usage in the virtualization environment.
*
* This action also accepts an optional cluster element to define the target cluster for this host.
*
* @author Oved Ourfali
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
interface Approve {
/**
* The host to approve.
*
* @author Aleksei Slaikovskii
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Host host();
@InputDetail
default void inputDetail() {
or(optional(cluster().id()), optional(cluster().name()));
}
/**
* The cluster where the host will be added after it is approved.
*
* @author Aleksei Slaikovskii
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Cluster cluster();
/**
* Indicates if the approval should be performed asynchronously.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Boolean async();
/**
* Approve the specified host to be added to the engine by using the root password (deprecated verb). This
* occurs when the host registers itself with the engine.
*
* @author Ori Liel
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
/**
* When set to 'true', this host will be activated after its approval completes. When set to 'false'
* the host will remain in 'maintenance' status after its approval. Absence of this parameter will be
* interpreted as 'true', since the desired default behavior is activating the host after approval.
* @author Ori Liel
* @date 10 Dec 2018
* @since 4.3
* @status added
*/
@In Boolean activate();
/**
* Indicates if the host should be rebooted after successful installation. The default value is `true`.
*
* @author Dana Elfassy
* @date 3 Feb 2021
*/
@In Boolean reboot();
interface UsingRootPassword extends Approve {
@InputDetail
default void inputDetail() {
mandatory(host().rootPassword());//DEPRECATED
}
}
/**
* Approve the specified host to be added to the engine by using ssh authentication. This occurs when the host
* registers itself with the engine.
*
* @author Ori Liel
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
interface UsingSsh extends Approve {
@InputDetail
default void inputDetail() {
mandatory(host().ssh().authenticationMethod());
mandatory(host().ssh().user().password());
mandatory(host().ssh().user().userName());
}
}
}
/**
* Marks the network configuration as good and persists it inside the host.
*
* An API user commits the network configuration to persist a host network interface attachment or detachment, or
* persist the creation and deletion of a bonded interface.
*
* IMPORTANT: Networking configuration is only committed after the engine has established that host connectivity is
* not lost as a result of the configuration changes. If host connectivity is lost, the host requires a reboot and
* automatically reverts to the previous networking configuration.
*
* For example, to commit the network configuration of host with id `123` send a request like this:
*
* [source]
* ----
* POST /ovirt-engine/api/hosts/123/commitnetconfig
* ----
*
* With a request body like this:
*
* [source,xml]
* ----
* > request, in which case the new
* configuration is automatically saved in the {hypervisor-name} upon completing the setup and
* re-establishing connectivity between the {hypervisor-name} and {engine-name}, and without
* waiting for a separate <> request.
*
* @author Juan Hernandez
* @author Martin Mucha
* @author Megan Lewis
* @author Eitan Raviv
* @date 03 Dec 2018
* @status added
*/
interface CommitNetConfig {
/**
* Indicates if the action should be performed asynchronously.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Boolean async();
}
/**
* Deactivates the host to perform maintenance tasks.
*
* @author Oved Ourfali
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
interface Deactivate {
@InputDetail
default void inputDetail() {
optional(reason());
}
@In String reason();
/**
* Indicates if the deactivation should be performed asynchronously.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Boolean async();
/**
* Indicates if the gluster service should be stopped as part of deactivating the host. It can be used while
* performing maintenance operations on the gluster host. Default value for this variable is `false`.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Boolean stopGlusterService();
}
/**
* Enrolls the certificate of the host. Useful in case you get a warning that it is about to expire or has already
* expired.
*
* @author Oved Ourfali
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
interface EnrollCertificate {
/**
* Indicates if the enrollment should be performed asynchronously.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Boolean async();
}
/**
* Controls the host's power management device.
*
* For example, to start the host. This can be done via:
*
* [source]
* ----
* #!/bin/sh -ex
*
* url="https://engine.example.com/ovirt-engine/api"
* user="admin@internal"
* password="..."
*
* curl \
* --verbose \
* --cacert /etc/pki/ovirt-engine/ca.pem \
* --user "${user}:${password}" \
* --request POST \
* --header "Version: 4" \
* --header "Content-Type: application/xml" \
* --header "Accept: application/xml" \
* --data '
*
* start
*
* ' \
* "${url}/hosts/123/fence"
* ----
* @author Oved Ourfali
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
interface Fence {
@InputDetail
default void inputDetail() {
mandatory(fenceType());
}
@In String fenceType();
@Out PowerManagement powerManagement();
/**
* Indicates if the fencing should be performed asynchronously.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Boolean async();
/**
* Indicates if host should be put into maintenance after restart.
*
* @author Artur Socha
* @date 10 Sep 19
* @since 4.4
* @status requires_text
*/
@In Boolean maintenanceAfterRestart();
}
/**
* To manually set a host as the storage pool manager (SPM).
*
* [source]
* ----
* POST /ovirt-engine/api/hosts/123/forceselectspm
* ----
*
* With a request body like this:
*
* [source,xml]
* ----
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
interface ForceSelectSpm {
/**
* Indicates if the action should be performed asynchronously.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Boolean async();
}
/**
* Gets the host details.
*
* [source]
* ----
* GET /ovirt-engine/api/hosts/123
* ----
*
* @author Oved Ourfali
* @author Aleksei Slaikovskii
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
interface Get extends Follow {
/**
* The queried host.
*
* @author Aleksei Slaikovskii
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@Out Host host();
/**
* Indicates if the results should be filtered according to the permissions of the user.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Boolean filter();
/**
* Indicates if all of the attributes of the host should be included in the response.
*
* By default the following attributes are excluded:
*
* - `hosted_engine`
*
* For example, to retrieve the complete representation of host '123':
*
* ....
* GET /ovirt-engine/api/hosts/123?all_content=true
* ....
*
* NOTE: These attributes are not included by default because retrieving them impacts performance. They are
* seldom used and require additional queries to the database. Use this parameter with caution and only when
* specifically required.
*
* @author Juan Hernandez
* @author Tahlia Richardson
* @date 26 Apr 2017
* @status updated_by_docs
*/
@In Boolean allContent();
}
/**
* 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.
*
* @author Oved Ourfali
* @author Roy Golan
* @author Megan Lewis
* @author Eli Marcus
* @date 17 Jul 2019
* @status updated_by_docs
*/
interface Install {
@InputDetail
default void inputDetail() {
optional(host().overrideIptables());
optional(image());
}
/**
* 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.
* @author Ori Liel
* @date 10 Dec 2018
* @since 4.3
* @status added
*/
@In Boolean activate();
/**
* Install VDSM and other packages required to get the host ready to be used in the engine providing the root
* password. This has been deprecated.
*
* @author Ori Liel
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
interface UsingRootPassword extends Install {
@InputDetail
default void inputDetail() {
optional(rootPassword());
}
}
/**
* Install VDSM and other packages required to get the host ready to be used in the engine providing the SSH
* password.
*
* @author Ori Liel
* @author Megan Lewis
* @author Artur Socha
* @date 29 Jan 21
* @status requires_text
*/
interface UsingSsh extends Install {
@InputDetail
default void inputDetail() {
optional(ssh().authenticationMethod());
optional(ssh().fingerprint());
optional(ssh().publicKey());
optional(ssh().port());
optional(ssh().user().password());
optional(ssh().user().userName());
}
}
/**
* The password of the `root` user used to connect to the host via SSH.
*
* @author Megan Lewis
* @author Eli Marcus
* @date 17 Jul 2019
* @status updated_by_docs
*/
@In String rootPassword();
/**
* The SSH details used to connect to the host.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Ssh ssh();
/**
* The `override_iptables` property is used to indicate if the firewall configuration should be replaced by the
* default one.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Host host();
/**
* When installing {hypervisor-name}, an ISO image file is required.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In String image();
/**
* Indicates if the installation should be performed asynchronously.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Boolean async();
/**
* 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.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Boolean deployHostedEngine();
/**
* 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.
*
* @author Megan Lewis
* @author Eli Marcus
* @date 17 Jul 2019
* @status updated_by_docs
*/
@In Boolean undeployHostedEngine();
/**
* Indicates if the host should be rebooted after successful installation. The default value is `true`.
*
* @author Dana Elfassy
* @date 3 Feb 2021
*/
@In Boolean reboot();
}
/**
* This method has been deprecated since Engine version 4.4.6.
* DiscoverIscsi should be used instead.
*
* Discovers iSCSI targets on the host, using the initiator details.
* Returns an array of strings containing the discovered data.
*
* For example, to discover iSCSI targets available in `myiscsi.example.com`,
* from host `123`, send a request like this:
*
* [source]
* ----
* POST /ovirt-engine/api/hosts/123/iscsidiscover
* ----
*
* With a request body like this:
*
* [source,xml]
* ----
*
*
* myiscsi.example.com
*
*
* ----
*
* @author Oved Ourfali
* @author Megan Lewis
* @author Ala Hino
* @author Ori Liel
* @date 15 Feb 2021
* @status updated
*/
@Deprecated
interface IscsiDiscover {
@InputDetail
default void inputDetail() {
mandatory(iscsi().address());
}
/**
* The target iSCSI device.
*
* @author Oved Ourfali
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In IscsiDetails iscsi();
/**
* The iSCSI targets.
* *
* @author Oved Ourfali
* @author Megan Lewis
* @author Ala Hino
* @date 23 Nov 2017
* @status updated_by_docs
*/
@Out String[] iscsiTargets();
/**
* Indicates if the discovery should be performed asynchronously.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Boolean async();
}
/**
* Discovers iSCSI targets on the host, using the initiator details.
* Returns a list of IscsiDetails objects containing the discovered data.
*
* For example, to discover iSCSI targets available in `myiscsi.example.com`,
* from host `123`, send a request like this:
*
* [source]
* ----
* POST /ovirt-engine/api/hosts/123/discoveriscsi
* ----
*
* With a request body like this:
*
* [source,xml]
* ----
*
*
* myiscsi.example.com
*
*
* ----
*
* The result will be like this:
*
* [source,xml]
* ----
*
*
* 10.35.1.72
* 3260
* 10.35.1.72:3260,1
* iqn.2015-08.com.tgt:444
*
*
* ----
*
* IMPORTANT: When using this method to discover iscsi targets, you can use an FQDN or an
* IP address, but you must use the iscsi details from the discovered targets results to log in
* using the iscsilogin method.
*
* @author Ori Liel
* @author Eli Marcus
* @date 21 Jul 2021
* @status updated_by_docs
* @since 4.4.6
*/
interface DiscoverIscsi {
@InputDetail
default void inputDetail() {
mandatory(iscsi().address());
}
/**
* The target iSCSI device.
*
* @author Ori Liel
* @date 15 Feb 2021
* @status added
* @since 4.4.6
*/
@In IscsiDetails iscsi();
/**
* Indicates if the discovery should be performed asynchronously.
*
* @author Ori Liel
* @date 15 Feb 2021
* @status added
* @since 4.4.6
*/
@In Boolean async();
/**
* The discovered targets including all connection information.
*
* @author Ori Liel
* @date 15 Feb 2021
* @status added
* @since 4.4.6
*/
@Out IscsiDetails[] discoveredTargets();
}
/**
* Login to iSCSI targets on the host, using the target details.
*
*
* IMPORTANT: When using this method to log in, you must use the iscsi details from the
* discovered targets results in the discoveriscsi method.
*
* @author Oved Ourfali
* @author Megan Lewis
* @author Eli Marcus
* @date 21 Jul 2021
* @status updated_by_docs
*/
interface IscsiLogin {
@InputDetail
default void inputDetail() {
mandatory(iscsi().address());
mandatory(iscsi().target());
}
/**
* The target iSCSI device.
*
* @author Oved Ourfali
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In IscsiDetails iscsi();
/**
* Indicates if the login should be performed asynchronously.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Boolean async();
}
/**
* Discovers the block Storage Domains which are candidates to be imported to the setup. For FCP no arguments are
* required.
*
* @author Ori Liel
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
interface UnregisteredStorageDomainsDiscover {
@InputDetail
default void inputDetail() {
optional(iscsi().address());
optional(iscsi().target());
}
@In IscsiDetails iscsi();
@Out StorageDomain[] storageDomains();
/**
* Indicates if the discovery should be performed asynchronously.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Boolean async();
}
/**
* Update the host properties.
*
* For example, to update a the kernel command line of a host send a request like this:
*
* [source]
* ----
* PUT /ovirt-engine/api/hosts/123
* ----
*
* With request body like this:
*
* [source, xml]
* ----
*
*
* vfio_iommu_type1.allow_unsafe_interrupts=1
*
*
* ----
*
* @author Jakub Niedermertl
* @author Oved Ourfali
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
interface Update {
@InputDetail
default void inputDetail() {
optional(host().address());
optional(host().comment());
optional(host().display().address());
optional(host().name());
optional(host().port());
optional(host().powerManagement().automaticPmEnabled());
optional(host().powerManagement().enabled());
optional(host().powerManagement().kdumpDetection());
optional(host().spm().priority());
optional(host().vgpuPlacement());
or(optional(host().cluster().id()), optional(host().cluster().name()));
// optional(host().powerManagement()[COLLECTION].propietary!!();
}
/**
* Update the specified host in the system. This is deprecated and is provided only for backwards compatibility.
*
* @author Ori Liel
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
interface UsingRootPassword extends Update {
@InputDetail
default void inputDetail() {
optional(host().externalHostProvider().id());
optional(host().rootPassword()); //DEPRECATED
}
}
/**
* Updates the specified host in the system.
*
* @author Ori Liel
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
interface UsingSsh extends Update {
@InputDetail
default void inputDetail() {
optional(host().ssh().fingerprint());
optional(host().ssh().publicKey());
optional(host().ssh().port());
optional(host().ssh().user().userName());
}
}
@In @Out Host host();
/**
* Indicates if the update should be performed asynchronously.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Boolean async();
}
/**
* Upgrades VDSM and selected software on the host.
*
* @author Oved Ourfali
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
interface Upgrade {
@InputDetail
/**
* This method is no longer relevant, since Vintage Node is no longer supported, and has been deprecated.
*
* @author Dana Elfassy
* @author Eli Marcus
* @date 17 Jul 2019
* @status updated_by_docs
*/
@Deprecated
default void inputDetail() {
optional(image());
}
/**
* This property is no longer relevant, since Vintage Node is no longer supported, and has been deprecated.
*
* @author Dana Elfassy
* @author Eli Marcus
* @date 21 Aug 2019
* @status updated_by_docs
*/
@Deprecated
@In String image();
/**
* Indicates if the host should be rebooted after the upgrade.
* By default the host is rebooted.
*
* NOTE: This parameter is ignored for {hypervisor-name}, which is always rebooted after the upgrade.
*
* @author Ondra Machacek
* @author Byron Gravenorst
* @author Eli Marcus
* @date 17 Jul 2019
* @status updated_by_docs
* @since 4.2
*/
@In Boolean reboot();
/**
* Indicates if the upgrade should be performed asynchronously.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Boolean async();
/**
* Upgrade timeout.
*
* The maximum time to wait for upgrade to finish in minutes.
* Default value is specified by `ANSIBLE_PLAYBOOK_EXEC_DEFAULT_TIMEOUT` configration option.
*
* @author Ondra Machacek
* @date 29 Aug 2019
* @status added
* @since 4.3.6
*/
@In Integer timeout();
}
/**
* Check if there are upgrades available for the host. If there are upgrades available an icon will be displayed
* next to host status icon in the Administration Portal. Audit log messages are also added to indicate the
* availability of upgrades. The upgrade can be started from the webadmin or by using the
* <> host action.
*
* @author Ravi Nori
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
* @since 4.1
*/
interface UpgradeCheck {
}
/**
* Refresh the host devices and capabilities.
*
* @author Oved Ourfali
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
interface Refresh {
/**
* Indicates if the refresh should be performed asynchronously.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Boolean async();
}
/**
* Remove the host from the system.
*
* [source]
* ----
* #!/bin/sh -ex
*
* url="https://engine.example.com/ovirt-engine/api"
* user="admin@internal"
* password="..."
*
* curl \
* --verbose \
* --cacert /etc/pki/ovirt-engine/ca.pem \
* --user "${user}:${password}" \
* --request DELETE \
* --header "Version: 4" \
* "${url}/hosts/1ff7a191-2f3b-4eff-812b-9f91a30c3acc"
* ----
*
* @author Oved Ourfali
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
interface Remove {
/**
* Indicates that the host should be removed even if it is non-responsive,
* or if it is part of a Gluster Storage cluster and has volume bricks on it.
*
* @author Ori Liel
* @date 17 Jan 2019
* @status added
* @since 4.3
*/
@In Boolean force();
/**
* Indicates if the remove should be performed asynchronously.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Boolean async();
}
/**
* This method is used to change the configuration of the network interfaces of a host.
*
* For example, if you have a host with three network interfaces `eth0`, `eth1` and `eth2` and you want to configure
* a new bond using `eth0` and `eth1`, and put a VLAN on top of it. Using a simple shell script and the `curl`
* command line HTTP client that can be done as follows:
*
* [source]
* ----
* #!/bin/sh -ex
*
* url="https://engine.example.com/ovirt-engine/api"
* user="admin@internal"
* password="..."
*
* curl \
* --verbose \
* --cacert /etc/pki/ovirt-engine/ca.pem \
* --user "${user}:${password}" \
* --request POST \
* --header "Version: 4" \
* --header "Content-Type: application/xml" \
* --header "Accept: application/xml" \
* --data '
*
*
*
* bond0
*
*
*
*
*
*
*
* eth1
*
*
* eth2
*
*
*
*
*
*
*
*
* myvlan
*
*
* bond0
*
*
*
* static
*
* 192.168.122.10
* 255.255.255.0
*
*
*
*
*
* 1.1.1.1
* 2.2.2.2
*
*
*
*
*
* ' \
* "${url}/hosts/1ff7a191-2f3b-4eff-812b-9f91a30c3acc/setupnetworks"
* ----
*
* NOTE: This is valid for version 4 of the API. In previous versions some elements were represented as XML
* attributes instead of XML elements. In particular the `options` and `ip` elements were represented as follows:
*
* [source,xml]
* ----
* >.
*
* IMPORTANT: Since {engine-name} 4.3, it is possible to also specify `commit_on_success` in
* the <> request, in which case the new
* configuration is automatically saved in the {hypervisor-name} upon completing the setup and
* re-establishing connectivity between the {hypervisor-name} and {engine-name}, and without
* waiting for a separate <> request.
*
*
* @author Megan Lewis
* @author Eitan Raviv
* @author Eli Marcus
* @date 17 Jul 2019
* @status updated_by_docs
*/
interface SetupNetworks {
@InputDetail
default void inputDetail() {
optional(commitOnSuccess());
optional(checkConnectivity());
optional(connectivityTimeout());
or(optional(modifiedNetworkAttachments()[COLLECTION].hostNic().name()), optional(modifiedNetworkAttachments()[COLLECTION].hostNic().id()));
optional(modifiedNetworkAttachments()[COLLECTION].id());
optional(modifiedNetworkAttachments()[COLLECTION].ipAddressAssignments()[COLLECTION].ip());
optional(modifiedNetworkAttachments()[COLLECTION].ipAddressAssignments()[COLLECTION].assignmentMethod());
or(optional(modifiedNetworkAttachments()[COLLECTION].network().name()), optional(modifiedNetworkAttachments()[COLLECTION].network().id()));
optional(modifiedNetworkAttachments()[COLLECTION].properties()[COLLECTION].name());
optional(modifiedNetworkAttachments()[COLLECTION].properties()[COLLECTION].value());
optional(removedLabels()[COLLECTION].id());
optional(synchronizedNetworkAttachments()[COLLECTION].id());
optional(removedNetworkAttachments()[COLLECTION].id());
or(optional(modifiedLabels()[COLLECTION].hostNic().name()), optional(modifiedLabels()[COLLECTION].hostNic().id()));
optional(modifiedLabels()[COLLECTION].id());
// optional(modifiedBonds()[COLLECTION].slaves().hostNic--collection());
optional(modifiedBonds()[COLLECTION].bonding().options()[COLLECTION].name());
optional(modifiedBonds()[COLLECTION].bonding().options()[COLLECTION].value());
or(optional(modifiedBonds()[COLLECTION].name()), optional(modifiedBonds()[COLLECTION].id()));
or(optional(removedBonds()[COLLECTION].name()), optional(removedBonds()[COLLECTION].id()));
}
@In NetworkAttachment[] modifiedNetworkAttachments();
@In NetworkAttachment[] removedNetworkAttachments();
/**
* A list of network attachments that will be synchronized.
*
* @author Leon Goldberg
* @author Byron Gravenorst
* @date 31 Jan 18
* @status updated_by_docs
*/
@In NetworkAttachment[] synchronizedNetworkAttachments();
@In HostNic[] modifiedBonds();
@In HostNic[] removedBonds();
@In NetworkLabel[] modifiedLabels();
@In NetworkLabel[] removedLabels();
/**
* Specifies whether to automatically save the configuration in the {hypervisor-name} upon completing
* the setup and re-establishing connectivity between the {hypervisor-name} and {engine-name},
* and without waiting for a separate <>
* request.
* The default value is `false`, which means that the configuration will not be
* saved automatically.
*
* @author Eitan Raviv
* @date 03 Dec 2018
* @since 4.3
* @status added
*/
@In Boolean commitOnSuccess();
@In Boolean checkConnectivity();
@In Integer connectivityTimeout();
/**
* Indicates if the action should be performed asynchronously.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@In Boolean async();
}
/**
* To synchronize all networks on the host, send a request like this:
*
* [source]
* ----
* POST /ovirt-engine/api/hosts/123/syncallnetworks
* ----
*
* With a request body like this:
*
* [source,xml]
* ----
*
* @author Tahlia Richardson
* @date 07 Feb 18
* @since 4.2.2
* @status updated_by_docs
*/
interface SyncAllNetworks {
/**
* Indicates if the action should be performed asynchronously.
*
* @author Leon Goldberg
* @author Tahlia Richardson
* @date 30 Jan 18
* @status updated_by_docs
*/
@In Boolean async();
}
/**
* Copy the network configuration of the specified host to current host.
*
* IMPORTANT: Any network attachments that are not present on the source host will be erased from the target host
* by the copy operation.
*
* To copy networks from another host, send a request like this:
*
* [source]
* ----
* POST /ovirt-engine/api/hosts/123/copyhostnetworks
* ----
*
* With a request body like this:
*
* [source,xml]
* ----
*
*
* ----
*
* @author Ales Musil
* @author Andrej Cernek
* @date 12 Mar 2020
* @status added
* @since 4.4
*/
interface CopyHostNetworks {
@InputDetail
default void inputDetail() {
mandatory(sourceHost().id());
}
/**
* The host to copy networks from.
*
* @author Ales Musil
* @date 15 Oct 2019
* @status added
*/
@In Host sourceHost();
/**
* Indicates if the action should be performed asynchronously.
*
* @author Ales Musil
* @date 15 Oct 2019
* @status added
*/
@In Boolean async();
}
/**
* A reference to the host permission service.
* Use this service to manage permissions on the host object.
*
* @author Oved Ourfali
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@Service AssignedPermissionsService permissions();
/**
* A reference to the host tags service. Use this service to manage tags on the host object.
*
* @author Oved Ourfali
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@Service AssignedTagsService tags();
/**
* A reference to the fence agents service. Use this service to manage fence and power management agents on the host
* object.
*
* @author Oved Ourfali
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@Service FenceAgentsService fenceAgents();
/**
* A reference to the host devices service. Use this service to view the devices of the host object.
*
* @author Oved Ourfali
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@Service HostDevicesService devices();
/**
* A reference to the host hooks service. Use this service to view the hooks available in the host object.
*
* @author Oved Ourfali
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@Service HostHooksService hooks();
/**
* A reference to the service that manages the network interface devices on the host.
*
* @author Martin Mucha
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@Service HostNicsService nics();
/**
* A reference to the service that manage NUMA nodes for the host.
*
* @author Yaniv Bronheim
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@Service HostNumaNodesService numaNodes();
/**
* A reference to the service that manages the host's storage.
*
* @author Yaniv Bronheim
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@Service HostStorageService storage();
/**
* A reference to the service that can show the applicable errata available on the host. This information is taken
* from Katello.
*
* @author Oved Ourfali
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@Service KatelloErrataService katelloErrata();
/**
* A reference to the network attachments service. You can use this service to attach Logical networks to host
* interfaces.
*
* @author Oved Ourfali
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@Service NetworkAttachmentsService networkAttachments();
/**
* A reference to storage connection extensions.
*
* @author Yaniv Bronheim
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@Service StorageServerConnectionExtensionsService storageConnectionExtensions();
/**
* A reference to unmanaged networks.
*
* @author Yaniv Bronheim
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@Service UnmanagedNetworksService unmanagedNetworks();
/**
* List of scheduling labels assigned to this host.
*
* @author Megan Lewis
* @date 17 Oct 17
* @status updated_by_docs
*/
@Service AssignedAffinityLabelsService affinityLabels();
/**
* External network providers provisioned by the system on the host.
*
* @author Dominik Holler
* @author Byron Gravenorst
* @date 09 Oct 2017
* @status updated_by_docs
* @since 4.2
*/
@Service ExternalNetworkProviderConfigurationsService externalNetworkProviderConfigurations();
}