Class: OvirtSDK4::SystemService

Inherits:
Service
  • Object
show all
Defined in:
lib/ovirtsdk4/services.rb,
lib/ovirtsdk4/services.rb

Instance Method Summary collapse

Methods inherited from Service

#inspect, #to_s

Instance Method Details

#affinity_labels_service ⇒ AffinityLabelsService

List all known affinity labels.

Returns:



25578
25579
25580
 
# File 'lib/ovirtsdk4/services.rb', line 25578

def affinity_labels_service
  @affinity_labels_service ||= AffinityLabelsService.new(self, 'affinitylabels')
end

#bookmarks_service ⇒ BookmarksService

Locates the bookmarks service.

Returns:



25587
25588
25589
 
# File 'lib/ovirtsdk4/services.rb', line 25587

def bookmarks_service
  @bookmarks_service ||= BookmarksService.new(self, 'bookmarks')
end

#cluster_levels_service ⇒ ClusterLevelsService

Reference to the service that provides information about the cluster levels supported by the system.

Returns:



25596
25597
25598
 
# File 'lib/ovirtsdk4/services.rb', line 25596

def cluster_levels_service
  @cluster_levels_service ||= ClusterLevelsService.new(self, 'clusterlevels')
end

#clusters_service ⇒ ClustersService

Locates the clusters service.

Returns:



25605
25606
25607
 
# File 'lib/ovirtsdk4/services.rb', line 25605

def clusters_service
  @clusters_service ||= ClustersService.new(self, 'clusters')
end

#cpu_profiles_service ⇒ CpuProfilesService

Locates the cpu_profiles service.

Returns:



25614
25615
25616
 
# File 'lib/ovirtsdk4/services.rb', line 25614

def cpu_profiles_service
  @cpu_profiles_service ||= CpuProfilesService.new(self, 'cpuprofiles')
end

#data_centers_service ⇒ DataCentersService

Locates the data_centers service.

Returns:



25623
25624
25625
 
# File 'lib/ovirtsdk4/services.rb', line 25623

def data_centers_service
  @data_centers_service ||= DataCentersService.new(self, 'datacenters')
end

#disk_profiles_service ⇒ DiskProfilesService

Locates the disk_profiles service.

Returns:



25632
25633
25634
 
# File 'lib/ovirtsdk4/services.rb', line 25632

def disk_profiles_service
  @disk_profiles_service ||= DiskProfilesService.new(self, 'diskprofiles')
end

#disks_service ⇒ DisksService

Locates the disks service.

Returns:



25641
25642
25643
 
# File 'lib/ovirtsdk4/services.rb', line 25641

def disks_service
  @disks_service ||= DisksService.new(self, 'disks')
end

#domains_service ⇒ DomainsService

Locates the domains service.

Returns:



25650
25651
25652
 
# File 'lib/ovirtsdk4/services.rb', line 25650

def domains_service
  @domains_service ||= DomainsService.new(self, 'domains')
end

#events_service ⇒ EventsService

Locates the events service.

Returns:



25659
25660
25661
 
# File 'lib/ovirtsdk4/services.rb', line 25659

def events_service
  @events_service ||= EventsService.new(self, 'events')
end

#external_host_providers_service ⇒ ExternalHostProvidersService

Locates the external_host_providers service.

Returns:



25668
25669
25670
 
# File 'lib/ovirtsdk4/services.rb', line 25668

def external_host_providers_service
  @external_host_providers_service ||= ExternalHostProvidersService.new(self, 'externalhostproviders')
end

#external_template_imports_service ⇒ ExternalTemplateImportsService

Reference to service facilitating import of external templates.

Returns:



25677
25678
25679
 
# File 'lib/ovirtsdk4/services.rb', line 25677

def external_template_imports_service
  @external_template_imports_service ||= ExternalTemplateImportsService.new(self, 'externaltemplateimports')
end

#external_vm_imports_service ⇒ ExternalVmImportsService

Reference to service facilitating import of external virtual machines.

Returns:



25686
25687
25688
 
# File 'lib/ovirtsdk4/services.rb', line 25686

def external_vm_imports_service
  @external_vm_imports_service ||= ExternalVmImportsService.new(self, 'externalvmimports')
end

#get(opts = {}) ⇒ Api

Returns basic information describing the API, like the product name, the version number and a summary of the number of relevant objects.

GET /ovirt-engine/api

We get following response:

<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.

Parameters:

  • opts (Hash) (defaults to: {}) —

    Additional options.

Options Hash (opts):

  • :follow (String) —

    Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.

  • :headers (Hash) — default: {} —

    Additional HTTP headers.

  • :query (Hash) — default: {} —

    Additional URL query parameters.

  • :timeout (Integer) — default: 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.

  • :wait (Boolean) — default: true —

    If true wait for the response.

Returns:



25543
25544
25545
 
# File 'lib/ovirtsdk4/services.rb', line 25543

def get(opts = {})
  internal_get(GET, opts)
end

#groups_service ⇒ GroupsService

Locates the groups service.

Returns:



25695
25696
25697
 
# File 'lib/ovirtsdk4/services.rb', line 25695

def groups_service
  @groups_service ||= GroupsService.new(self, 'groups')
end

#hosts_service ⇒ HostsService

Locates the hosts service.

Returns:



25704
25705
25706
 
# File 'lib/ovirtsdk4/services.rb', line 25704

def hosts_service
  @hosts_service ||= HostsService.new(self, 'hosts')
end

#icons_service ⇒ IconsService

Locates the icons service.

Returns:



25713
25714
25715
 
# File 'lib/ovirtsdk4/services.rb', line 25713

def icons_service
  @icons_service ||= IconsService.new(self, 'icons')
end

#image_transfers_service ⇒ ImageTransfersService

List of all image transfers being performed for image I/O in oVirt.

Returns:



25722
25723
25724
 
# File 'lib/ovirtsdk4/services.rb', line 25722

def image_transfers_service
  @image_transfers_service ||= ImageTransfersService.new(self, 'imagetransfers')
end

#instance_types_service ⇒ InstanceTypesService

Locates the instance_types service.

Returns:



25731
25732
25733
 
# File 'lib/ovirtsdk4/services.rb', line 25731

def instance_types_service
  @instance_types_service ||= InstanceTypesService.new(self, 'instancetypes')
end

#jobs_service ⇒ JobsService

List all the jobs monitored by the engine.

Returns:



25740
25741
25742
 
# File 'lib/ovirtsdk4/services.rb', line 25740

def jobs_service
  @jobs_service ||= JobsService.new(self, 'jobs')
end

#katello_errata_service ⇒ EngineKatelloErrataService

List the available Katello errata assigned to the engine.

Returns:



25749
25750
25751
 
# File 'lib/ovirtsdk4/services.rb', line 25749

def katello_errata_service
  @katello_errata_service ||= EngineKatelloErrataService.new(self, 'katelloerrata')
end

#mac_pools_service ⇒ MacPoolsService

Locates the mac_pools service.

Returns:



25758
25759
25760
 
# File 'lib/ovirtsdk4/services.rb', line 25758

def mac_pools_service
  @mac_pools_service ||= MacPoolsService.new(self, 'macpools')
end

#network_filters_service ⇒ NetworkFiltersService

Network filters will enhance the admin ability to manage the network packets traffic from/to the participated VMs.

Returns:



25768
25769
25770
 
# File 'lib/ovirtsdk4/services.rb', line 25768

def network_filters_service
  @network_filters_service ||= NetworkFiltersService.new(self, 'networkfilters')
end

#networks_service ⇒ NetworksService

Locates the networks service.

Returns:



25777
25778
25779
 
# File 'lib/ovirtsdk4/services.rb', line 25777

def networks_service
  @networks_service ||= NetworksService.new(self, 'networks')
end

#openstack_image_providers_service ⇒ OpenstackImageProvidersService

Locates the openstack_image_providers service.

Returns:



25786
25787
25788
 
# File 'lib/ovirtsdk4/services.rb', line 25786

def openstack_image_providers_service
  @openstack_image_providers_service ||= OpenstackImageProvidersService.new(self, 'openstackimageproviders')
end

#openstack_network_providers_service ⇒ OpenstackNetworkProvidersService

Locates the openstack_network_providers service.

Returns:



25795
25796
25797
 
# File 'lib/ovirtsdk4/services.rb', line 25795

def openstack_network_providers_service
  @openstack_network_providers_service ||= OpenstackNetworkProvidersService.new(self, 'openstacknetworkproviders')
end

#openstack_volume_providers_service ⇒ OpenstackVolumeProvidersService

Locates the openstack_volume_providers service.

Returns:



25804
25805
25806
 
# File 'lib/ovirtsdk4/services.rb', line 25804

def openstack_volume_providers_service
  @openstack_volume_providers_service ||= OpenstackVolumeProvidersService.new(self, 'openstackvolumeproviders')
end

#operating_systems_service ⇒ OperatingSystemsService

Locates the operating_systems service.

Returns:



25813
25814
25815
 
# File 'lib/ovirtsdk4/services.rb', line 25813

def operating_systems_service
  @operating_systems_service ||= OperatingSystemsService.new(self, 'operatingsystems')
end

#options_service ⇒ SystemOptionsService

Reference to the service that provides values of configuration options of the system.

Returns:



25822
25823
25824
 
# File 'lib/ovirtsdk4/services.rb', line 25822

def options_service
  @options_service ||= SystemOptionsService.new(self, 'options')
end

#permissions_service ⇒ SystemPermissionsService

Locates the permissions service.

Returns:



25831
25832
25833
 
# File 'lib/ovirtsdk4/services.rb', line 25831

def permissions_service
  @permissions_service ||= SystemPermissionsService.new(self, 'permissions')
end

#reload_configurations(opts = {}) ⇒ Object

Executes the reload_configurations method.

Parameters:

  • opts (Hash) (defaults to: {}) —

    Additional options.

Options Hash (opts):

  • :async (Boolean) —

    Indicates if the reload should be performed asynchronously.

  • :headers (Hash) — default: {} —

    Additional HTTP headers.

  • :query (Hash) — default: {} —

    Additional URL query parameters.

  • :timeout (Integer) — default: 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.

  • :wait (Boolean) — default: true —

    If true wait for the response.



25569
25570
25571
 
# File 'lib/ovirtsdk4/services.rb', line 25569

def reload_configurations(opts = {})
  internal_action(:reloadconfigurations, nil, RELOAD_CONFIGURATIONS, opts)
end

#roles_service ⇒ RolesService

Locates the roles service.

Returns:



25840
25841
25842
 
# File 'lib/ovirtsdk4/services.rb', line 25840

def roles_service
  @roles_service ||= RolesService.new(self, 'roles')
end

#scheduling_policies_service ⇒ SchedulingPoliciesService

Locates the scheduling_policies service.

Returns:



25849
25850
25851
 
# File 'lib/ovirtsdk4/services.rb', line 25849

def scheduling_policies_service
  @scheduling_policies_service ||= SchedulingPoliciesService.new(self, 'schedulingpolicies')
end

#scheduling_policy_units_service ⇒ SchedulingPolicyUnitsService

Locates the scheduling_policy_units service.

Returns:



25858
25859
25860
 
# File 'lib/ovirtsdk4/services.rb', line 25858

def scheduling_policy_units_service
  @scheduling_policy_units_service ||= SchedulingPolicyUnitsService.new(self, 'schedulingpolicyunits')
end

#service(path) ⇒ Service

Locates the service corresponding to the given path.

Parameters:

  • path (String) —

    The path of the service.

Returns:

  • (Service) —

    A reference to the service.

Raises:



25941
25942
25943
25944
25945
25946
25947
25948
25949
25950
25951
25952
25953
25954
25955
25956
25957
25958
25959
25960
25961
25962
25963
25964
25965
25966
25967
25968
25969
25970
25971
25972
25973
25974
25975
25976
25977
25978
25979
25980
25981
25982
25983
25984
25985
25986
25987
25988
25989
25990
25991
25992
25993
25994
25995
25996
25997
25998
25999
26000
26001
26002
26003
26004
26005
26006
26007
26008
26009
26010
26011
26012
26013
26014
26015
26016
26017
26018
26019
26020
26021
26022
26023
26024
26025
26026
26027
26028
26029
26030
26031
26032
26033
26034
26035
26036
26037
26038
26039
26040
26041
26042
26043
26044
26045
26046
26047
26048
26049
26050
26051
26052
26053
26054
26055
26056
26057
26058
26059
26060
26061
26062
26063
26064
26065
26066
26067
26068
26069
26070
26071
26072
26073
26074
26075
26076
26077
26078
26079
26080
26081
26082
26083
26084
26085
26086
26087
26088
26089
26090
26091
26092
26093
26094
26095
26096
26097
26098
26099
26100
26101
26102
26103
26104
26105
26106
26107
26108
26109
26110
26111
26112
26113
26114
26115
26116
26117
26118
26119
26120
26121
26122
26123
26124
26125
26126
26127
26128
26129
26130
26131
26132
26133
26134
26135
26136
26137
26138
26139
26140
26141
26142
26143
26144
26145
26146
26147
26148
26149
26150
26151
26152
26153
26154
26155
26156
26157
26158
26159
26160
26161
26162
26163
26164
26165
26166
26167
26168
26169
26170
26171
26172
26173
26174
26175
26176
26177
26178
26179
26180
26181
26182
26183
26184
26185
26186
 
# 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

#storage_connections_service ⇒ StorageServerConnectionsService

Locates the storage_connections service.

Returns:



25867
25868
25869
 
# File 'lib/ovirtsdk4/services.rb', line 25867

def storage_connections_service
  @storage_connections_service ||= StorageServerConnectionsService.new(self, 'storageconnections')
end

#storage_domains_service ⇒ StorageDomainsService

Locates the storage_domains service.

Returns:



25876
25877
25878
 
# File 'lib/ovirtsdk4/services.rb', line 25876

def storage_domains_service
  @storage_domains_service ||= StorageDomainsService.new(self, 'storagedomains')
end

#tags_service ⇒ TagsService

Locates the tags service.

Returns:



25885
25886
25887
 
# File 'lib/ovirtsdk4/services.rb', line 25885

def tags_service
  @tags_service ||= TagsService.new(self, 'tags')
end

#templates_service ⇒ TemplatesService

Locates the templates service.

Returns:



25894
25895
25896
 
# File 'lib/ovirtsdk4/services.rb', line 25894

def templates_service
  @templates_service ||= TemplatesService.new(self, 'templates')
end

#users_service ⇒ UsersService

Locates the users service.

Returns:



25903
25904
25905
 
# File 'lib/ovirtsdk4/services.rb', line 25903

def users_service
  @users_service ||= UsersService.new(self, 'users')
end

#vm_pools_service ⇒ VmPoolsService

Locates the vm_pools service.

Returns:



25912
25913
25914
 
# File 'lib/ovirtsdk4/services.rb', line 25912

def vm_pools_service
  @vm_pools_service ||= VmPoolsService.new(self, 'vmpools')
end

#vms_service ⇒ VmsService

Locates the vms service.

Returns:



25921
25922
25923
 
# File 'lib/ovirtsdk4/services.rb', line 25921

def vms_service
  @vms_service ||= VmsService.new(self, 'vms')
end

#vnic_profiles_service ⇒ VnicProfilesService

Locates the vnic_profiles service.

Returns:



25930
25931
25932
 
# File 'lib/ovirtsdk4/services.rb', line 25930

def vnic_profiles_service
  @vnic_profiles_service ||= VnicProfilesService.new(self, 'vnicprofiles')
end