class OvirtSDK4::SystemService
Constants
- GET
- RELOAD_CONFIGURATIONS
Public Instance Methods
List
all known affinity labels.
@return [AffinityLabelsService] A reference to `affinity_labels` service.
# File lib/ovirtsdk4/services.rb, line 25578 def affinity_labels_service @affinity_labels_service ||= AffinityLabelsService.new(self, 'affinitylabels') end
Locates the `bookmarks` service.
@return [BookmarksService] A reference to `bookmarks` service.
# File lib/ovirtsdk4/services.rb, line 25587 def bookmarks_service @bookmarks_service ||= BookmarksService.new(self, 'bookmarks') end
Reference to the service that provides information about the cluster levels supported by the system.
@return [ClusterLevelsService] A reference to `cluster_levels` service.
# File lib/ovirtsdk4/services.rb, line 25596 def cluster_levels_service @cluster_levels_service ||= ClusterLevelsService.new(self, 'clusterlevels') end
Locates the `clusters` service.
@return [ClustersService] A reference to `clusters` service.
# File lib/ovirtsdk4/services.rb, line 25605 def clusters_service @clusters_service ||= ClustersService.new(self, 'clusters') end
Locates the `cpu_profiles` service.
@return [CpuProfilesService] A reference to `cpu_profiles` service.
# File lib/ovirtsdk4/services.rb, line 25614 def cpu_profiles_service @cpu_profiles_service ||= CpuProfilesService.new(self, 'cpuprofiles') end
Locates the `data_centers` service.
@return [DataCentersService] A reference to `data_centers` service.
# File lib/ovirtsdk4/services.rb, line 25623 def data_centers_service @data_centers_service ||= DataCentersService.new(self, 'datacenters') end
Locates the `disk_profiles` service.
@return [DiskProfilesService] A reference to `disk_profiles` service.
# File lib/ovirtsdk4/services.rb, line 25632 def disk_profiles_service @disk_profiles_service ||= DiskProfilesService.new(self, 'diskprofiles') end
Locates the `disks` service.
@return [DisksService] A reference to `disks` service.
# File lib/ovirtsdk4/services.rb, line 25641 def disks_service @disks_service ||= DisksService.new(self, 'disks') end
Locates the `domains` service.
@return [DomainsService] A reference to `domains` service.
# File lib/ovirtsdk4/services.rb, line 25650 def domains_service @domains_service ||= DomainsService.new(self, 'domains') end
Locates the `events` service.
@return [EventsService] A reference to `events` service.
# File lib/ovirtsdk4/services.rb, line 25659 def events_service @events_service ||= EventsService.new(self, 'events') end
Locates the `external_host_providers` service.
@return [ExternalHostProvidersService] A reference to `external_host_providers` service.
# File lib/ovirtsdk4/services.rb, line 25668 def external_host_providers_service @external_host_providers_service ||= ExternalHostProvidersService.new(self, 'externalhostproviders') end
Reference to service facilitating import of external templates.
@return [ExternalTemplateImportsService] A reference to `external_template_imports` service.
# File lib/ovirtsdk4/services.rb, line 25677 def external_template_imports_service @external_template_imports_service ||= ExternalTemplateImportsService.new(self, 'externaltemplateimports') end
Reference to service facilitating import of external virtual machines.
@return [ExternalVmImportsService] A reference to `external_vm_imports` service.
# File lib/ovirtsdk4/services.rb, line 25686 def external_vm_imports_service @external_vm_imports_service ||= ExternalVmImportsService.new(self, 'externalvmimports') end
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
<api>
<link rel="capabilities" href="/api/capabilities"/> <link rel="clusters" href="/api/clusters"/> <link rel="clusters/search" href="/api/clusters?search={query}"/> <link rel="datacenters" href="/api/datacenters"/> <link rel="datacenters/search" href="/api/datacenters?search={query}"/> <link rel="events" href="/api/events"/> <link rel="events/search" href="/api/events?search={query}"/> <link rel="hosts" href="/api/hosts"/> <link rel="hosts/search" href="/api/hosts?search={query}"/> <link rel="networks" href="/api/networks"/> <link rel="roles" href="/api/roles"/> <link rel="storagedomains" href="/api/storagedomains"/> <link rel="storagedomains/search" href="/api/storagedomains?search={query}"/> <link rel="tags" href="/api/tags"/> <link rel="templates" href="/api/templates"/> <link rel="templates/search" href="/api/templates?search={query}"/> <link rel="users" href="/api/users"/> <link rel="groups" href="/api/groups"/> <link rel="domains" href="/api/domains"/> <link rel="vmpools" href="/api/vmpools"/> <link rel="vmpools/search" href="/api/vmpools?search={query}"/> <link rel="vms" href="/api/vms"/> <link rel="vms/search" href="/api/vms?search={query}"/> <product_info> <name>oVirt Engine</name> <vendor>ovirt.org</vendor> <version> <build>4</build> <full_version>4.0.4</full_version> <major>4</major> <minor>0</minor> <revision>0</revision> </version> </product_info> <special_objects> <blank_template href="/ovirt-engine/api/templates/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000"/> <root_tag href="/ovirt-engine/api/tags/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000"/> </special_objects> <summary> <hosts> <active>0</active> <total>0</total> </hosts> <storage_domains> <active>0</active> <total>1</total> </storage_domains> <users> <active>1</active> <total>1</total> </users> <vms> <active>0</active> <total>0</total> </vms> </summary> <time>2016-09-14T12:00:48.132+02:00</time>
</api>
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`.
@param opts [Hash] Additional options.
@option opts [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 <<documents/003_common_concepts/follow, here>> for details.
@option opts [Hash] :headers ({}) Additional HTTP headers.
@option opts [Hash] :query ({}) Additional URL query parameters.
@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
given then the timeout set globally for the connection will be used.
@option opts [Boolean] :wait (true) If `true` wait for the response.
@return [Api]
# File lib/ovirtsdk4/services.rb, line 25543 def get(opts = {}) internal_get(GET, opts) end
Locates the `groups` service.
@return [GroupsService] A reference to `groups` service.
# File lib/ovirtsdk4/services.rb, line 25695 def groups_service @groups_service ||= GroupsService.new(self, 'groups') end
Locates the `hosts` service.
@return [HostsService] A reference to `hosts` service.
# File lib/ovirtsdk4/services.rb, line 25704 def hosts_service @hosts_service ||= HostsService.new(self, 'hosts') end
Locates the `icons` service.
@return [IconsService] A reference to `icons` service.
# File lib/ovirtsdk4/services.rb, line 25713 def icons_service @icons_service ||= IconsService.new(self, 'icons') end
List
of all image transfers being performed for image I/O in oVirt.
@return [ImageTransfersService] A reference to `image_transfers` service.
# File lib/ovirtsdk4/services.rb, line 25722 def image_transfers_service @image_transfers_service ||= ImageTransfersService.new(self, 'imagetransfers') end
Locates the `instance_types` service.
@return [InstanceTypesService] A reference to `instance_types` service.
# File lib/ovirtsdk4/services.rb, line 25731 def instance_types_service @instance_types_service ||= InstanceTypesService.new(self, 'instancetypes') end
List
all the jobs monitored by the engine.
@return [JobsService] A reference to `jobs` service.
# File lib/ovirtsdk4/services.rb, line 25740 def jobs_service @jobs_service ||= JobsService.new(self, 'jobs') end
List
the available Katello errata assigned to the engine.
@return [EngineKatelloErrataService] A reference to `katello_errata` service.
# File lib/ovirtsdk4/services.rb, line 25749 def katello_errata_service @katello_errata_service ||= EngineKatelloErrataService.new(self, 'katelloerrata') end
Locates the `mac_pools` service.
@return [MacPoolsService] A reference to `mac_pools` service.
# File lib/ovirtsdk4/services.rb, line 25758 def mac_pools_service @mac_pools_service ||= MacPoolsService.new(self, 'macpools') end
Network
filters will enhance the admin ability to manage the network packets traffic from/to the participated VMs.
@return [NetworkFiltersService] A reference to `network_filters` service.
# File lib/ovirtsdk4/services.rb, line 25768 def network_filters_service @network_filters_service ||= NetworkFiltersService.new(self, 'networkfilters') end
Locates the `networks` service.
@return [NetworksService] A reference to `networks` service.
# File lib/ovirtsdk4/services.rb, line 25777 def networks_service @networks_service ||= NetworksService.new(self, 'networks') end
Locates the `openstack_image_providers` service.
@return [OpenstackImageProvidersService] A reference to `openstack_image_providers` service.
# File lib/ovirtsdk4/services.rb, line 25786 def openstack_image_providers_service @openstack_image_providers_service ||= OpenstackImageProvidersService.new(self, 'openstackimageproviders') end
Locates the `openstack_network_providers` service.
@return [OpenstackNetworkProvidersService] A reference to `openstack_network_providers` service.
# File lib/ovirtsdk4/services.rb, line 25795 def openstack_network_providers_service @openstack_network_providers_service ||= OpenstackNetworkProvidersService.new(self, 'openstacknetworkproviders') end
Locates the `openstack_volume_providers` service.
@return [OpenstackVolumeProvidersService] A reference to `openstack_volume_providers` service.
# File lib/ovirtsdk4/services.rb, line 25804 def openstack_volume_providers_service @openstack_volume_providers_service ||= OpenstackVolumeProvidersService.new(self, 'openstackvolumeproviders') end
Locates the `operating_systems` service.
@return [OperatingSystemsService] A reference to `operating_systems` service.
# File lib/ovirtsdk4/services.rb, line 25813 def operating_systems_service @operating_systems_service ||= OperatingSystemsService.new(self, 'operatingsystems') end
Reference to the service that provides values of configuration options of the system.
@return [SystemOptionsService] A reference to `options` service.
# File lib/ovirtsdk4/services.rb, line 25822 def options_service @options_service ||= SystemOptionsService.new(self, 'options') end
Locates the `permissions` service.
@return [SystemPermissionsService] A reference to `permissions` service.
# File lib/ovirtsdk4/services.rb, line 25831 def permissions_service @permissions_service ||= SystemPermissionsService.new(self, 'permissions') end
Executes the `reload_configurations` method.
@param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the reload should be performed asynchronously.
@option opts [Hash] :headers ({}) Additional HTTP headers.
@option opts [Hash] :query ({}) Additional URL query parameters.
@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
given then the timeout set globally for the connection will be used.
@option opts [Boolean] :wait (true) If `true` wait for the response.
# File lib/ovirtsdk4/services.rb, line 25569 def reload_configurations(opts = {}) internal_action(:reloadconfigurations, nil, RELOAD_CONFIGURATIONS, opts) end
Locates the `roles` service.
@return [RolesService] A reference to `roles` service.
# File lib/ovirtsdk4/services.rb, line 25840 def roles_service @roles_service ||= RolesService.new(self, 'roles') end
Locates the `scheduling_policies` service.
@return [SchedulingPoliciesService] A reference to `scheduling_policies` service.
# File lib/ovirtsdk4/services.rb, line 25849 def scheduling_policies_service @scheduling_policies_service ||= SchedulingPoliciesService.new(self, 'schedulingpolicies') end
Locates the `scheduling_policy_units` service.
@return [SchedulingPolicyUnitsService] A reference to `scheduling_policy_units` service.
# File lib/ovirtsdk4/services.rb, line 25858 def scheduling_policy_units_service @scheduling_policy_units_service ||= SchedulingPolicyUnitsService.new(self, 'schedulingpolicyunits') end
Locates the service corresponding to the given path.
@param path [String] The path of the service.
@return [Service] A reference to the service.
# File lib/ovirtsdk4/services.rb, line 25941 def service(path) if path.nil? || path == '' return self end if path == 'affinitylabels' return affinity_labels_service end if path.start_with?('affinitylabels/') return affinity_labels_service.service(path[15..-1]) end if path == 'bookmarks' return bookmarks_service end if path.start_with?('bookmarks/') return bookmarks_service.service(path[10..-1]) end if path == 'clusterlevels' return cluster_levels_service end if path.start_with?('clusterlevels/') return cluster_levels_service.service(path[14..-1]) end if path == 'clusters' return clusters_service end if path.start_with?('clusters/') return clusters_service.service(path[9..-1]) end if path == 'cpuprofiles' return cpu_profiles_service end if path.start_with?('cpuprofiles/') return cpu_profiles_service.service(path[12..-1]) end if path == 'datacenters' return data_centers_service end if path.start_with?('datacenters/') return data_centers_service.service(path[12..-1]) end if path == 'diskprofiles' return disk_profiles_service end if path.start_with?('diskprofiles/') return disk_profiles_service.service(path[13..-1]) end if path == 'disks' return disks_service end if path.start_with?('disks/') return disks_service.service(path[6..-1]) end if path == 'domains' return domains_service end if path.start_with?('domains/') return domains_service.service(path[8..-1]) end if path == 'events' return events_service end if path.start_with?('events/') return events_service.service(path[7..-1]) end if path == 'externalhostproviders' return external_host_providers_service end if path.start_with?('externalhostproviders/') return external_host_providers_service.service(path[22..-1]) end if path == 'externaltemplateimports' return external_template_imports_service end if path.start_with?('externaltemplateimports/') return external_template_imports_service.service(path[24..-1]) end if path == 'externalvmimports' return external_vm_imports_service end if path.start_with?('externalvmimports/') return external_vm_imports_service.service(path[18..-1]) end if path == 'groups' return groups_service end if path.start_with?('groups/') return groups_service.service(path[7..-1]) end if path == 'hosts' return hosts_service end if path.start_with?('hosts/') return hosts_service.service(path[6..-1]) end if path == 'icons' return icons_service end if path.start_with?('icons/') return icons_service.service(path[6..-1]) end if path == 'imagetransfers' return image_transfers_service end if path.start_with?('imagetransfers/') return image_transfers_service.service(path[15..-1]) end if path == 'instancetypes' return instance_types_service end if path.start_with?('instancetypes/') return instance_types_service.service(path[14..-1]) end if path == 'jobs' return jobs_service end if path.start_with?('jobs/') return jobs_service.service(path[5..-1]) end if path == 'katelloerrata' return katello_errata_service end if path.start_with?('katelloerrata/') return katello_errata_service.service(path[14..-1]) end if path == 'macpools' return mac_pools_service end if path.start_with?('macpools/') return mac_pools_service.service(path[9..-1]) end if path == 'networkfilters' return network_filters_service end if path.start_with?('networkfilters/') return network_filters_service.service(path[15..-1]) end if path == 'networks' return networks_service end if path.start_with?('networks/') return networks_service.service(path[9..-1]) end if path == 'openstackimageproviders' return openstack_image_providers_service end if path.start_with?('openstackimageproviders/') return openstack_image_providers_service.service(path[24..-1]) end if path == 'openstacknetworkproviders' return openstack_network_providers_service end if path.start_with?('openstacknetworkproviders/') return openstack_network_providers_service.service(path[26..-1]) end if path == 'openstackvolumeproviders' return openstack_volume_providers_service end if path.start_with?('openstackvolumeproviders/') return openstack_volume_providers_service.service(path[25..-1]) end if path == 'operatingsystems' return operating_systems_service end if path.start_with?('operatingsystems/') return operating_systems_service.service(path[17..-1]) end if path == 'options' return options_service end if path.start_with?('options/') return options_service.service(path[8..-1]) end if path == 'permissions' return permissions_service end if path.start_with?('permissions/') return permissions_service.service(path[12..-1]) end if path == 'roles' return roles_service end if path.start_with?('roles/') return roles_service.service(path[6..-1]) end if path == 'schedulingpolicies' return scheduling_policies_service end if path.start_with?('schedulingpolicies/') return scheduling_policies_service.service(path[19..-1]) end if path == 'schedulingpolicyunits' return scheduling_policy_units_service end if path.start_with?('schedulingpolicyunits/') return scheduling_policy_units_service.service(path[22..-1]) end if path == 'storageconnections' return storage_connections_service end if path.start_with?('storageconnections/') return storage_connections_service.service(path[19..-1]) end if path == 'storagedomains' return storage_domains_service end if path.start_with?('storagedomains/') return storage_domains_service.service(path[15..-1]) end if path == 'tags' return tags_service end if path.start_with?('tags/') return tags_service.service(path[5..-1]) end if path == 'templates' return templates_service end if path.start_with?('templates/') return templates_service.service(path[10..-1]) end if path == 'users' return users_service end if path.start_with?('users/') return users_service.service(path[6..-1]) end if path == 'vmpools' return vm_pools_service end if path.start_with?('vmpools/') return vm_pools_service.service(path[8..-1]) end if path == 'vms' return vms_service end if path.start_with?('vms/') return vms_service.service(path[4..-1]) end if path == 'vnicprofiles' return vnic_profiles_service end if path.start_with?('vnicprofiles/') return vnic_profiles_service.service(path[13..-1]) end raise Error.new("The path \"#{path}\" doesn't correspond to any service") end
Locates the `storage_connections` service.
@return [StorageServerConnectionsService] A reference to `storage_connections` service.
# File lib/ovirtsdk4/services.rb, line 25867 def storage_connections_service @storage_connections_service ||= StorageServerConnectionsService.new(self, 'storageconnections') end
Locates the `storage_domains` service.
@return [StorageDomainsService] A reference to `storage_domains` service.
# File lib/ovirtsdk4/services.rb, line 25876 def storage_domains_service @storage_domains_service ||= StorageDomainsService.new(self, 'storagedomains') end
Locates the `templates` service.
@return [TemplatesService] A reference to `templates` service.
# File lib/ovirtsdk4/services.rb, line 25894 def templates_service @templates_service ||= TemplatesService.new(self, 'templates') end
Locates the `users` service.
@return [UsersService] A reference to `users` service.
# File lib/ovirtsdk4/services.rb, line 25903 def users_service @users_service ||= UsersService.new(self, 'users') end
Locates the `vm_pools` service.
@return [VmPoolsService] A reference to `vm_pools` service.
# File lib/ovirtsdk4/services.rb, line 25912 def vm_pools_service @vm_pools_service ||= VmPoolsService.new(self, 'vmpools') end
Locates the `vms` service.
@return [VmsService] A reference to `vms` service.
# File lib/ovirtsdk4/services.rb, line 25921 def vms_service @vms_service ||= VmsService.new(self, 'vms') end
Locates the `vnic_profiles` service.
@return [VnicProfilesService] A reference to `vnic_profiles` service.
# File lib/ovirtsdk4/services.rb, line 25930 def vnic_profiles_service @vnic_profiles_service ||= VnicProfilesService.new(self, 'vnicprofiles') end