services.SystemService 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-2016 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.Out;
import org.ovirt.api.metamodel.annotations.Root;
import org.ovirt.api.metamodel.annotations.Service;
import services.aaa.DomainsService;
import services.aaa.GroupsService;
import services.aaa.UsersService;
import services.externalhostproviders.EngineKatelloErrataService;
import services.externalhostproviders.ExternalHostProvidersService;
import services.openstack.OpenstackImageProvidersService;
import services.openstack.OpenstackNetworkProvidersService;
import services.openstack.OpenstackVolumeProvidersService;
import types.Api;
@Root
@Area("Infrastructure")
public interface SystemService {
/**
* Returns basic information describing the API, like the product name, the version number and a summary of the
* number of relevant objects.
*
* [source]
* ----
* GET /ovirt-engine/api
* ----
*
* We get following response:
*
* [source,xml]
* ----
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
* oVirt Engine
* ovirt.org
*
* 4
* 4.0.4
* 4
* 0
* 0
*
*
*
*
*
*
* 0
* 0
*
*
* 0
* 1
*
*
* 1
* 1
*
*
* 0
* 0
*
*
*
*
* ----
*
* The entry point provides a user with links to the collections in a
* virtualization environment. The `rel` attribute of each collection link
* provides a reference point for each link.
*
* The entry point also contains other data such as `product_info`,
* `special_objects` and `summary`.
*
* @author Piotr Kliczewski
* @date 14 Sep 2016
* @status added
*/
interface Get extends Follow {
@Out Api api();
}
interface ReloadConfigurations {
/**
* Indicates if the reload should be performed asynchronously.
*/
@In Boolean async();
}
/**
* Reference to the service that provides information about the cluster levels supported by the system.
*/
@Service ClusterLevelsService clusterLevels();
@Service BookmarksService bookmarks();
@Service ClustersService clusters();
@Service CpuProfilesService cpuProfiles();
@Service DataCentersService dataCenters();
@Service DiskProfilesService diskProfiles();
@Service DisksService disks();
@Service DomainsService domains();
@Service EventsService events();
@Service ExternalHostProvidersService externalHostProviders();
/**
* Reference to service facilitating import of external virtual machines.
*
* @author Martin Betak
* @date 27 Jul 2016
* @status added
* @since 4.0.4
*/
@Service ExternalVmImportsService externalVmImports();
/**
* Reference to service facilitating import of external templates.
*
* @author Liran Rotenberg
* @date 12 May 2021
* @status added
* @since 4.4.7
*/
@Service ExternalTemplateImportsService externalTemplateImports();
@Service GroupsService groups();
@Service HostsService hosts();
@Service IconsService icons();
@Service InstanceTypesService instanceTypes();
/**
* List all the jobs monitored by the engine.
*
* @author Moti Asayag
* @date 12 Dec 2016
* @status added
*/
@Service JobsService jobs();
/**
* List all known affinity labels.
*/
@Service AffinityLabelsService affinityLabels();
@Service MacPoolsService macPools();
/**
* Network filters will enhance the admin ability to manage the network packets traffic from/to the participated
* VMs.
*/
@Service NetworkFiltersService networkFilters();
@Service NetworksService networks();
@Service OpenstackImageProvidersService openstackImageProviders();
@Service OpenstackNetworkProvidersService openstackNetworkProviders();
@Service OpenstackVolumeProvidersService openstackVolumeProviders();
@Service OperatingSystemsService operatingSystems();
@Service RolesService roles();
@Service SchedulingPoliciesService schedulingPolicies();
@Service SchedulingPolicyUnitsService schedulingPolicyUnits();
@Service StorageDomainsService storageDomains();
@Service StorageServerConnectionsService storageConnections();
/**
* List the available Katello errata assigned to the engine.
*
* @author Moti Asayag
* @date 12 Dec 2016
* @status added
*/
@Service EngineKatelloErrataService katelloErrata();
@Service SystemPermissionsService permissions();
@Service TagsService tags();
@Service TemplatesService templates();
@Service UsersService users();
@Service VmPoolsService vmPools();
@Service VmsService vms();
@Service VnicProfilesService vnicProfiles();
/**
* List of all image transfers being performed for image I/O in oVirt.
*
* @author Amit Aviram
* @date 30 Aug 2016
* @status added
* @since 4.0.4
*/
@Service ImageTransfersService imageTransfers();
/**
* Reference to the service that provides values of configuration options of the system.
*
* @author Miroslava Voglova
* @date 18 Sep 2017
* @status added
* @since 4.2
*/
@Service SystemOptionsService options();
}