Package org.ovirt.engine.sdk4.services
Interface HostsService.ListRequest
-
- All Superinterfaces:
Request<HostsService.ListRequest,HostsService.ListResponse>
- Enclosing interface:
- HostsService
public static interface HostsService.ListRequest extends Request<HostsService.ListRequest,HostsService.ListResponse>
Get a list of all available hosts. For example, to list the hosts send the following request: .... GET /ovirt-engine/api/hosts .... The response body will be similar to this: [source,xml] ----... ... ... ---- The order of the returned list of hosts is guaranteed only if the `sortby` clause is included in the `search` parameter.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description HostsService.ListRequest
allContent(Boolean allContent)
Indicates if all of the attributes of the hosts should be included in the response.HostsService.ListRequest
caseSensitive(Boolean caseSensitive)
Indicates if the search performed using the `search` parameter should be performed taking case into account.HostsService.ListRequest
checkVmsInAffinityClosure(Boolean checkVmsInAffinityClosure)
This parameter can be used with `migration_target_of` to get valid migration targets for the listed virtual machines and all other virtual machines that are in positive enforcing affinity with the listed virtual machines.HostsService.ListRequest
filter(Boolean filter)
Indicates if the results should be filtered according to the permissions of the user.HostsService.ListRequest
follow(String follow)
Indicates which inner links should be _followed_.HostsService.ListRequest
max(Integer max)
Sets the maximum number of hosts to return.HostsService.ListRequest
max(Long max)
Sets the maximum number of hosts to return.HostsService.ListRequest
max(BigInteger max)
Sets the maximum number of hosts to return.HostsService.ListRequest
migrationTargetOf(String migrationTargetOf)
Accepts a comma-separated list of virtual machine IDs and returns the hosts that these virtual machines can be migrated to.HostsService.ListRequest
search(String search)
A query string used to restrict the returned hosts.
-
-
-
Method Detail
-
allContent
HostsService.ListRequest allContent(Boolean allContent)
Indicates if all of the attributes of the hosts should be included in the response. By default the following host attributes are excluded: - `hosted_engine` For example, to retrieve the complete representation of the hosts: .... GET /ovirt-engine/api/hosts?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.
-
caseSensitive
HostsService.ListRequest caseSensitive(Boolean caseSensitive)
Indicates if the search performed using the `search` parameter should be performed taking case into account. The default value is `true`, which means that case is taken into account. If you want to search ignoring case set it to `false`.
-
checkVmsInAffinityClosure
HostsService.ListRequest checkVmsInAffinityClosure(Boolean checkVmsInAffinityClosure)
This parameter can be used with `migration_target_of` to get valid migration targets for the listed virtual machines and all other virtual machines that are in positive enforcing affinity with the listed virtual machines. This is useful in case the virtual machines will be migrated together with others in positive affinity groups. The default value is `false`. .... GET /ovirt-engine/api/hosts?migration_target_of=123,456&check_vms_in_affinity_closure=true ....
-
filter
HostsService.ListRequest filter(Boolean filter)
Indicates if the results should be filtered according to the permissions of the user.
-
follow
HostsService.ListRequest follow(String follow)
Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part of the current request. See <> for details.
-
max
HostsService.ListRequest max(Integer max)
Sets the maximum number of hosts to return. If not specified all the hosts are returned.
-
max
HostsService.ListRequest max(Long max)
Sets the maximum number of hosts to return. If not specified all the hosts are returned.
-
max
HostsService.ListRequest max(BigInteger max)
Sets the maximum number of hosts to return. If not specified all the hosts are returned.
-
migrationTargetOf
HostsService.ListRequest migrationTargetOf(String migrationTargetOf)
Accepts a comma-separated list of virtual machine IDs and returns the hosts that these virtual machines can be migrated to. For example, to retrieve the list of hosts to which the virtual machine with ID 123 and the virtual machine with ID 456 can be migrated to, send the following request: .... GET /ovirt-engine/api/hosts?migration_target_of=123,456 ....
-
search
HostsService.ListRequest search(String search)
A query string used to restrict the returned hosts.
-
-