Interface SystemOptionService.GetRequest

  • All Superinterfaces:
    Request<SystemOptionService.GetRequest,​SystemOptionService.GetResponse>
    Enclosing interface:
    SystemOptionService

    public static interface SystemOptionService.GetRequest
    extends Request<SystemOptionService.GetRequest,​SystemOptionService.GetResponse>
    Get the values of specific configuration option. For example to retrieve the values of configuration option `MigrationPoliciesSupported` send a request like this: [source] ---- GET /ovirt-engine/api/options/MigrationPoliciesSupported ---- The response to that request will be the following: [source,xml] ---- MigrationPoliciesSupported true 4.0 true 4.1 true 4.2 false 3.6 ---- NOTE: The appropriate permissions are required to query configuration options. Some options can be queried only by users with administrator permissions. [IMPORTANT] ==== There is NO backward compatibility and no guarantee about the names or values of the options. Options may be removed and their meaning can be changed at any point. We strongly discourage the use of this service for applications other than the ones that are released simultaneously with the engine. Usage by other applications is not supported. Therefore there will be no documentation listing accessible configuration options. ====
    • Method Detail

      • version

        SystemOptionService.GetRequest version​(String version)
        Optional version parameter that specifies that only particular version of the configuration option should be returned. If this parameter isn't used then all the versions will be returned. For example, to get the value of the `MigrationPoliciesSupported` option but only for version `4.2` send a request like this: [source] ---- GET /ovirt-engine/api/options/MigrationPoliciesSupported?version=4.2 ---- The response to that request will be like this: [source,xml] ---- MigrationPoliciesSupported true 4.2 ----