Package org.ovirt.engine.sdk4.services

Interface ClusterService

  • All Superinterfaces:
    Service
    All Known Implementing Classes:
    ClusterServiceImpl
    public interface ClusterService
extends Service
    A service to manage a specific cluster.

    • Method Detail

      • get

        ClusterService.GetRequest get()
        Gets information about the cluster. An example of getting a cluster: [source] ---- GET /ovirt-engine/api/clusters/123 ---- [source,xml] ---- Default The default server cluster false x86_64 Intel Nehalem Family migrate true false 50 false false false true true 100 true inherit auto inherit random false false false 4 0 true ----

      • refreshGlusterHealStatus

        ClusterService.RefreshGlusterHealStatusRequest refreshGlusterHealStatus()
        Refresh the Gluster heal info for all volumes in cluster. For example, Cluster `123`, send a request like this: [source] ---- POST /ovirt-engine/api/clusters/123/refreshglusterhealstatus ----

      • remove

        ClusterService.RemoveRequest remove()
        Removes the cluster from the system. [source] ---- DELETE /ovirt-engine/api/clusters/00000000-0000-0000-0000-000000000000 ----

      • syncAllNetworks

        ClusterService.SyncAllNetworksRequest syncAllNetworks()
        Synchronizes all networks on the cluster. [source] ---- POST /ovirt-engine/api/clusters/123/syncallnetworks ---- With a request body like this: [source,xml] ---- ----

      • update

        ClusterService.UpdateRequest update()
        Updates information about the cluster. Only the specified fields are updated; others remain unchanged. For example, to update the cluster's CPU: [source] ---- PUT /ovirt-engine/api/clusters/123 ---- With a request body like this: [source,xml] ---- Intel Haswell-noTSX Family ----

      • upgrade

        ClusterService.UpgradeRequest upgrade()
        Start or finish upgrade process for the cluster based on the action value. This action marks the cluster for upgrade or clears the upgrade running flag on the cluster based on the action value which takes values of start or stop. [source] ---- POST /ovirt-engine/api/clusters/123/upgrade ---- With a request body like this to mark the cluster for upgrade: [source,xml] ---- start ----

      • affinityGroupsService

        AffinityGroupsService affinityGroupsService()
        A reference to the service that manages affinity groups.

      • cpuProfilesService

        AssignedCpuProfilesService cpuProfilesService()
        A reference to the service that manages assigned CPU profiles for the cluster.

      • enabledFeaturesService

        ClusterEnabledFeaturesService enabledFeaturesService()
        A reference to the service that manages the collection of enabled features for the cluster.

      • externalNetworkProvidersService

        ClusterExternalProvidersService externalNetworkProvidersService()
        A reference to the service that manages the collection of external network providers.

      • glusterHooksService

        GlusterHooksService glusterHooksService()
        A reference to the service that manages the Gluster hooks for the cluster.

      • glusterVolumesService

        GlusterVolumesService glusterVolumesService()
        A reference to the service that manages Gluster volumes for the cluster.

      • networkFiltersService

        NetworkFiltersService networkFiltersService()
        A sub-collection with all the supported network filters for the cluster.

      • networksService

        ClusterNetworksService networksService()
        A reference to the service that manages assigned networks for the cluster.

      • service

        Service service​(String path)
        Service locator method, returns individual service on which the URI is dispatched.