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 org.ovirt.api.metamodel.annotations.In;
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;
/**
* A service to manage a host.
*
* @author Yaniv Bronheim
* @date 12 Dec 2016
* @status added
*/
@Service
@Area("Infrastructure")
public interface HostService extends MeasurableService {
/**
* Activate the host for use, such as running virtual machines.
*
* @author Oved Ourfali
* @date 14 Sep 2016
* @status added
*/
interface Activate {
/**
* Indicates if the activation should be performed asynchronously.
*/
@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
* @date 14 Sep 2016
* @status added
*/
interface Approve {
/**
* Host to approve.
*
* @author Aleksei Slaikovskii
* @date 24 Apr 2017
* @status added
*/
@In Host host();
/**
* Cluster where the host will be added after approving it.
*
* @author Aleksei Slaikovskii
* @date 24 Apr 2017
* @status added
*/
@In Cluster cluster();
/**
* Indicates if the approval should be performed asynchronously.
*/
@In Boolean async();
}
/**
* 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]
* ----
*
* @author Martin Mucha
* @date 16 Aug 2016
* @status added
*/
interface CommitNetConfig {
/**
* Indicates if the action should be performed asynchronously.
*/
@In Boolean async();
}
/**
* Deactivate the host to perform maintenance tasks.
*
* @author Oved Ourfali
* @date 14 Sep 2016
* @status added
*/
interface Deactivate {
@In String reason();
/**
* Indicates if the deactivation should be performed asynchronously.
*/
@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`.
*/
@In Boolean stopGlusterService();
}
/**
* Enroll certificate of the host. Useful in case you get a warning that it is about to, or already expired.
*
* @author Oved Ourfali
* @date 14 Sep 2016
* @status added
*/
interface EnrollCertificate {
/**
* Indicates if the enrollment should be performed asynchronously.
*/
@In Boolean async();
}
/**
* Controls host's power management device.
*
* For example, let's assume you want 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
* @date 14 Sep 2016
* @status added
*/
interface Fence {
@In String fenceType();
@Out PowerManagement powerManagement();
/**
* Indicates if the fencing should be performed asynchronously.
*/
@In Boolean async();
}
/**
* 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]
* ----
*
* @date 14 Sep 2016
* @status added
*/
interface ForceSelectSpm {
/**
* Indicates if the action should be performed asynchronously.
*/
@In Boolean async();
}
/**
* Get the host details.
*
* [source]
* ----
* GET /ovirt-engine/api/hosts/123
* ----
*
* @author Oved Ourfali
* @author Aleksei Slaikovskii
* @date 24 Apr 2017
* @status added
*/
interface Get {
/**
* Queried host.
*
* @author Aleksei Slaikovskii
* @date 24 Apr 2017
* @status added
*/
@Out Host host();
/**
* Indicates if the results should be filtered according to the permissions of the user.
*/
@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();
}
/**
* Install VDSM and related software on the host. 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"
* }
* ' \
* "https://engine.example.com/ovirt-engine/api/hosts/123?deploy_hosted_engine=true"
* ----
*
* 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
* @date 14 Sep 2016
* @status added
*/
interface Install {
/**
* The password of of the `root` user, used to connect to the host via SSH.
*/
@In String rootPassword();
/**
* The SSH details used to connect to the host.
*/
@In Ssh ssh();
/**
* This `override_iptables` property is used to indicate if the firewall configuration should be
* replaced by the default one.
*/
@In Host host();
/**
* When installing an oVirt node a image ISO file is needed.
*/
@In String image();
/**
* Indicates if the installation should be performed asynchronously.
*/
@In Boolean async();
/**
* When set to `true` it means this host should deploy also hosted
* engine components. Missing value is treated as `true` i.e deploy.
* Omitting this parameter means `false` and will perform no operation
* in hosted engine area.
*/
@In Boolean deployHostedEngine();
/**
* When set to `true` it means this host should un-deploy hosted engine
* components and this host will not function as part of the High
* Availability cluster. Missing value is treated as `true` i.e un-deploy
* Omitting this parameter means `false` and will perform no operation
* in hosted engine area.
*/
@In Boolean undeployHostedEngine();
}
/**
* Discover iSCSI targets on the host, using the initiator details.
*
* @author Oved Ourfali
* @date 28 Nov 2016
* @status added
*/
interface IscsiDiscover {
/**
* The target iSCSI device.
*
* @author Oved Ourfali
* @date 28 Nov 2016
* @status added
*/
@In IscsiDetails iscsi();
/**
* The iSCSI targets.
*
* @author Oved Ourfali
* @date 28 Nov 2016
* @status added
*/
@Out String[] iscsiTargets();
/**
* Indicates if the discovery should be performed asynchronously.
*/
@In Boolean async();
}
/**
* Login to iSCSI targets on the host, using the target details.
*
* @author Oved Ourfali
* @date 28 Nov 2016
* @status added
*/
interface IscsiLogin {
/**
* The target iSCSI device.
*
* @author Oved Ourfali
* @date 28 Nov 2016
* @status added
*/
@In IscsiDetails iscsi();
/**
* Indicates if the login should be performed asynchronously.
*/
@In Boolean async();
}
interface UnregisteredStorageDomainsDiscover {
@In IscsiDetails iscsi();
@Out StorageDomain[] storageDomains();
/**
* Indicates if the discovery should be performed asynchronously.
*/
@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
* @date 14 Sep 2016
* @status added
*/
interface Update {
@In @Out Host host();
/**
* Indicates if the update should be performed asynchronously.
*/
@In Boolean async();
}
/**
* Upgrade VDSM and selected software on the host.
*
* @author Oved Ourfali
* @date 14 Sep 2016
* @status added
*/
interface Upgrade {
/**
* Indicates if the upgrade should be performed asynchronously.
*/
@In Boolean async();
}
/**
* 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 webadmin.
* 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
* @date 16 Aug 2016
* @status added
* @since 4.1
*/
interface UpgradeCheck {
}
/**
* Refresh the host devices and capabilities.
*
* @author Oved Ourfali
* @date 28 Nov 2016
* @status added
*/
interface Refresh {
/**
* Indicates if the refresh should be performed asynchronously.
*/
@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
* @date 14 Sep 2016
* @status added
*/
interface Remove {
/**
* Indicates if the remove should be performed asynchronously.
*/
@In Boolean async();
}
/**
* This method is used to change the configuration of the network interfaces of a host.
*
* For example, lets assume that you have a host with three network interfaces `eth0`, `eth1` and `eth2` and that
* 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 that 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]
* ----
* >.
*/
interface SetupNetworks {
@In NetworkAttachment[] modifiedNetworkAttachments();
@In NetworkAttachment[] removedNetworkAttachments();
@In NetworkAttachment[] synchronizedNetworkAttachments();
@In HostNic[] modifiedBonds();
@In HostNic[] removedBonds();
@In NetworkLabel[] modifiedLabels();
@In NetworkLabel[] removedLabels();
@In Boolean checkConnectivity();
@In Integer connectivityTimeout();
/**
* Indicates if the action should be performed asynchronously.
*/
@In Boolean async();
}
/**
* Reference to the host permission service.
* Use this service to manage permissions on the host object.
*
* @author Oved Ourfali
* @date 28 Nov 2016
* @status added
*/
@Service AssignedPermissionsService permissions();
/**
* Reference to the host tags service.
* Use this service to manage tags on the host object.
*
* @author Oved Ourfali
* @date 28 Nov 2016
* @status added
*/
@Service AssignedTagsService tags();
/**
* Reference to the fence agents service.
* Use this service to manage fence and power management agents on the host object.
*
* @author Oved Ourfali
* @date 28 Nov 2016
* @status added
*/
@Service FenceAgentsService fenceAgents();
/**
* Reference to the host devices service.
* Use this service to view the devices of the host object.
*
* @author Oved Ourfali
* @date 28 Nov 2016
* @status added
*/
@Service HostDevicesService devices();
/**
* Reference to the host hooks service.
* Use this service to view the hooks available in the host object.
*
* @author Oved Ourfali
* @date 28 Nov 2016
* @status added
*/
@Service HostHooksService hooks();
/**
* Reference to the service that manages the network interface devices on the host.
*
* @author Martin Mucha
* @date 14 Sep 2016
* @status added
*/
@Service HostNicsService nics();
/**
* Reference to the service that manage NUMA nodes for the host.
*
* @author Yaniv Bronheim
* @date 12 Dec 2016
* @status added
*/
@Service HostNumaNodesService numaNodes();
/**
* Reference to the service that manage hosts storage.
*
* @author Yaniv Bronheim
* @date 12 Dec 2016
* @status added
*/
@Service HostStorageService storage();
/**
* Reference to the service that can show the applicable errata available on the host.
* This information is taken from Katello.
*
* @author Oved Ourfali
* @date 28 Nov 2016
* @status added
*/
@Service KatelloErrataService katelloErrata();
/**
* Reference to the network attachments service. You can use this service to attach
* Logical networks to host interfaces.
*
* @author Oved Ourfali
* @date 28 Nov 2016
* @status added
*/
@Service NetworkAttachmentsService networkAttachments();
/**
* Reference to storage connection extensions.
*
* @author Yaniv Bronheim
* @date 12 Dec 2016
* @status added
*/
@Service StorageServerConnectionExtensionsService storageConnectionExtensions();
/**
* Reference to unmanaged networks.
*
* @author Yaniv Bronheim
* @date 12 Dec 2016
* @status added
*/
@Service UnmanagedNetworksService unmanagedNetworks();
/**
* List of scheduling labels assigned to this host.
*/
@Service AssignedAffinityLabelsService affinityLabels();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy