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:



23993
23994
23995
 
# File 'lib/ovirtsdk4/services.rb', line 23993

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

#bookmarks_service ⇒ BookmarksService

Locates the bookmarks service.

Returns:



24002
24003
24004
 
# File 'lib/ovirtsdk4/services.rb', line 24002

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:



24011
24012
24013
 
# File 'lib/ovirtsdk4/services.rb', line 24011

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

#clusters_service ⇒ ClustersService

Locates the clusters service.

Returns:



24020
24021
24022
 
# File 'lib/ovirtsdk4/services.rb', line 24020

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

#cpu_profiles_service ⇒ CpuProfilesService

Locates the cpu_profiles service.

Returns:



24029
24030
24031
 
# File 'lib/ovirtsdk4/services.rb', line 24029

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

#data_centers_service ⇒ DataCentersService

Locates the data_centers service.

Returns:



24038
24039
24040
 
# File 'lib/ovirtsdk4/services.rb', line 24038

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

#disk_profiles_service ⇒ DiskProfilesService

Locates the disk_profiles service.

Returns:



24047
24048
24049
 
# File 'lib/ovirtsdk4/services.rb', line 24047

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

#disks_service ⇒ DisksService

Locates the disks service.

Returns:



24056
24057
24058
 
# File 'lib/ovirtsdk4/services.rb', line 24056

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

#domains_service ⇒ DomainsService

Locates the domains service.

Returns:



24065
24066
24067
 
# File 'lib/ovirtsdk4/services.rb', line 24065

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

#events_service ⇒ EventsService

Locates the events service.

Returns:



24074
24075
24076
 
# File 'lib/ovirtsdk4/services.rb', line 24074

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

#external_host_providers_service ⇒ ExternalHostProvidersService

Locates the external_host_providers service.

Returns:



24083
24084
24085
 
# File 'lib/ovirtsdk4/services.rb', line 24083

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

#external_vm_imports_service ⇒ ExternalVmImportsService

Reference to service facilitating import of external virtual machines.

Returns:



24092
24093
24094
 
# File 'lib/ovirtsdk4/services.rb', line 24092

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:



23958
23959
23960
 
# File 'lib/ovirtsdk4/services.rb', line 23958

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

#groups_service ⇒ GroupsService

Locates the groups service.

Returns:



24101
24102
24103
 
# File 'lib/ovirtsdk4/services.rb', line 24101

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

#hosts_service ⇒ HostsService

Locates the hosts service.

Returns:



24110
24111
24112
 
# File 'lib/ovirtsdk4/services.rb', line 24110

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

#icons_service ⇒ IconsService

Locates the icons service.

Returns:



24119
24120
24121
 
# File 'lib/ovirtsdk4/services.rb', line 24119

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:



24128
24129
24130
 
# File 'lib/ovirtsdk4/services.rb', line 24128

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

#instance_types_service ⇒ InstanceTypesService

Locates the instance_types service.

Returns:



24137
24138
24139
 
# File 'lib/ovirtsdk4/services.rb', line 24137

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

#jobs_service ⇒ JobsService

List all the jobs monitored by the engine.

Returns:



24146
24147
24148
 
# File 'lib/ovirtsdk4/services.rb', line 24146

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

#katello_errata_service ⇒ EngineKatelloErrataService

List the available Katello errata assigned to the engine.

Returns:



24155
24156
24157
 
# File 'lib/ovirtsdk4/services.rb', line 24155

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

#mac_pools_service ⇒ MacPoolsService

Locates the mac_pools service.

Returns:



24164
24165
24166
 
# File 'lib/ovirtsdk4/services.rb', line 24164

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:



24174
24175
24176
 
# File 'lib/ovirtsdk4/services.rb', line 24174

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

#networks_service ⇒ NetworksService

Locates the networks service.

Returns:



24183
24184
24185
 
# File 'lib/ovirtsdk4/services.rb', line 24183

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

#openstack_image_providers_service ⇒ OpenstackImageProvidersService

Locates the openstack_image_providers service.

Returns:



24192
24193
24194
 
# File 'lib/ovirtsdk4/services.rb', line 24192

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:



24201
24202
24203
 
# File 'lib/ovirtsdk4/services.rb', line 24201

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:



24210
24211
24212
 
# File 'lib/ovirtsdk4/services.rb', line 24210

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

#operating_systems_service ⇒ OperatingSystemsService

Locates the operating_systems service.

Returns:



24219
24220
24221
 
# File 'lib/ovirtsdk4/services.rb', line 24219

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:



24228
24229
24230
 
# File 'lib/ovirtsdk4/services.rb', line 24228

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

#permissions_service ⇒ SystemPermissionsService

Locates the permissions service.

Returns:



24237
24238
24239
 
# File 'lib/ovirtsdk4/services.rb', line 24237

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.



23984
23985
23986
 
# File 'lib/ovirtsdk4/services.rb', line 23984

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

#roles_service ⇒ RolesService

Locates the roles service.

Returns:



24246
24247
24248
 
# File 'lib/ovirtsdk4/services.rb', line 24246

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

#scheduling_policies_service ⇒ SchedulingPoliciesService

Locates the scheduling_policies service.

Returns:



24255
24256
24257
 
# File 'lib/ovirtsdk4/services.rb', line 24255

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

#scheduling_policy_units_service ⇒ SchedulingPolicyUnitsService

Locates the scheduling_policy_units service.

Returns:



24264
24265
24266
 
# File 'lib/ovirtsdk4/services.rb', line 24264

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:



24347
24348
24349
24350
24351
24352
24353
24354
24355
24356
24357
24358
24359
24360
24361
24362
24363
24364
24365
24366
24367
24368
24369
24370
24371
24372
24373
24374
24375
24376
24377
24378
24379
24380
24381
24382
24383
24384
24385
24386
24387
24388
24389
24390
24391
24392
24393
24394
24395
24396
24397
24398
24399
24400
24401
24402
24403
24404
24405
24406
24407
24408
24409
24410
24411
24412
24413
24414
24415
24416
24417
24418
24419
24420
24421
24422
24423
24424
24425
24426
24427
24428
24429
24430
24431
24432
24433
24434
24435
24436
24437
24438
24439
24440
24441
24442
24443
24444
24445
24446
24447
24448
24449
24450
24451
24452
24453
24454
24455
24456
24457
24458
24459
24460
24461
24462
24463
24464
24465
24466
24467
24468
24469
24470
24471
24472
24473
24474
24475
24476
24477
24478
24479
24480
24481
24482
24483
24484
24485
24486
24487
24488
24489
24490
24491
24492
24493
24494
24495
24496
24497
24498
24499
24500
24501
24502
24503
24504
24505
24506
24507
24508
24509
24510
24511
24512
24513
24514
24515
24516
24517
24518
24519
24520
24521
24522
24523
24524
24525
24526
24527
24528
24529
24530
24531
24532
24533
24534
24535
24536
24537
24538
24539
24540
24541
24542
24543
24544
24545
24546
24547
24548
24549
24550
24551
24552
24553
24554
24555
24556
24557
24558
24559
24560
24561
24562
24563
24564
24565
24566
24567
24568
24569
24570
24571
24572
24573
24574
24575
24576
24577
24578
24579
24580
24581
24582
24583
24584
24585
24586
 
# File 'lib/ovirtsdk4/services.rb', line 24347

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 == '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:



24273
24274
24275
 
# File 'lib/ovirtsdk4/services.rb', line 24273

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

#storage_domains_service ⇒ StorageDomainsService

Locates the storage_domains service.

Returns:



24282
24283
24284
 
# File 'lib/ovirtsdk4/services.rb', line 24282

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

#tags_service ⇒ TagsService

Locates the tags service.

Returns:



24291
24292
24293
 
# File 'lib/ovirtsdk4/services.rb', line 24291

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

#templates_service ⇒ TemplatesService

Locates the templates service.

Returns:



24300
24301
24302
 
# File 'lib/ovirtsdk4/services.rb', line 24300

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

#users_service ⇒ UsersService

Locates the users service.

Returns:



24309
24310
24311
 
# File 'lib/ovirtsdk4/services.rb', line 24309

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

#vm_pools_service ⇒ VmPoolsService

Locates the vm_pools service.

Returns:



24318
24319
24320
 
# File 'lib/ovirtsdk4/services.rb', line 24318

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

#vms_service ⇒ VmsService

Locates the vms service.

Returns:



24327
24328
24329
 
# File 'lib/ovirtsdk4/services.rb', line 24327

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

#vnic_profiles_service ⇒ VnicProfilesService

Locates the vnic_profiles service.

Returns:



24336
24337
24338
 
# File 'lib/ovirtsdk4/services.rb', line 24336

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