Class: OvirtSDK4::TemplateService
- Defined in:
- lib/ovirtsdk4/services.rb,
lib/ovirtsdk4/services.rb
Instance Method Summary collapse
-
#cdroms_service ⇒ TemplateCdromsService
Returns a reference to the service that manages the CD-ROMs that are associated with the template.
-
#disk_attachments_service ⇒ TemplateDiskAttachmentsService
Returns a reference to the service that manages a specific disk attachment of the template.
-
#export(opts = {}) ⇒ Object
Exports a template to the data center export domain.
-
#export_to_export_domain(opts = {}) ⇒ Object
Exports a template to an export domain.
-
#export_to_path_on_host(opts = {}) ⇒ Object
Exports a template as an OVA file to a given path on a specified host.
-
#get(opts = {}) ⇒ Template
Returns the information about this template or template version.
-
#graphics_consoles_service ⇒ TemplateGraphicsConsolesService
Returns a reference to the service that manages the graphical consoles that are associated with the template.
-
#nics_service ⇒ TemplateNicsService
Returns a reference to the service that manages the NICs that are associated with the template.
-
#permissions_service ⇒ AssignedPermissionsService
Returns a reference to the service that manages the permissions that are associated with the template.
-
#remove(opts = {}) ⇒ Object
Removes a virtual machine template.
-
#service(path) ⇒ Service
Locates the service corresponding to the given path.
-
#tags_service ⇒ AssignedTagsService
Returns a reference to the service that manages the tags that are associated with the template.
-
#update(template, opts = {}) ⇒ Template
Updates the template.
-
#watchdogs_service ⇒ TemplateWatchdogsService
Returns a reference to the service that manages the watchdogs that are associated with the template.
Methods inherited from Service
Instance Method Details
#cdroms_service ⇒ TemplateCdromsService
Returns a reference to the service that manages the CD-ROMs that are associated with the template.
25884 25885 25886 |
# File 'lib/ovirtsdk4/services.rb', line 25884 def cdroms_service @cdroms_service ||= TemplateCdromsService.new(self, 'cdroms') end |
#disk_attachments_service ⇒ TemplateDiskAttachmentsService
Returns a reference to the service that manages a specific disk attachment of the template.
25894 25895 25896 |
# File 'lib/ovirtsdk4/services.rb', line 25894 def @disk_attachments_service ||= TemplateDiskAttachmentsService.new(self, 'diskattachments') end |
#export(opts = {}) ⇒ Object
Exports a template to the data center export domain.
For example, send the following request:
POST /ovirt-engine/api/templates/123/export
With a request body like this:
<action>
<storage_domain id="456"/>
<exclusive>true<exclusive/>
</action>
25677 25678 25679 |
# File 'lib/ovirtsdk4/services.rb', line 25677 def export(opts = {}) internal_action(:export, nil, EXPORT, opts) end |
#export_to_export_domain(opts = {}) ⇒ Object
Exports a template to an export domain.
25771 25772 25773 |
# File 'lib/ovirtsdk4/services.rb', line 25771 def export_to_export_domain(opts = {}) internal_action(:export, nil, EXPORT_TO_EXPORT_DOMAIN, opts) end |
#export_to_path_on_host(opts = {}) ⇒ Object
Exports a template as an OVA file to a given path on a specified host.
25815 25816 25817 |
# File 'lib/ovirtsdk4/services.rb', line 25815 def export_to_path_on_host(opts = {}) internal_action(:export, nil, EXPORT_TO_PATH_ON_HOST, opts) end |
#get(opts = {}) ⇒ Template
Returns the information about this template or template version.
25709 25710 25711 |
# File 'lib/ovirtsdk4/services.rb', line 25709 def get(opts = {}) internal_get(GET, opts) end |
#graphics_consoles_service ⇒ TemplateGraphicsConsolesService
Returns a reference to the service that manages the graphical consoles that are associated with the template.
25903 25904 25905 |
# File 'lib/ovirtsdk4/services.rb', line 25903 def graphics_consoles_service @graphics_consoles_service ||= TemplateGraphicsConsolesService.new(self, 'graphicsconsoles') end |
#nics_service ⇒ TemplateNicsService
Returns a reference to the service that manages the NICs that are associated with the template.
25912 25913 25914 |
# File 'lib/ovirtsdk4/services.rb', line 25912 def nics_service @nics_service ||= TemplateNicsService.new(self, 'nics') end |
#permissions_service ⇒ AssignedPermissionsService
Returns a reference to the service that manages the permissions that are associated with the template.
25921 25922 25923 |
# File 'lib/ovirtsdk4/services.rb', line 25921 def @permissions_service ||= AssignedPermissionsService.new(self, 'permissions') end |
#remove(opts = {}) ⇒ Object
Removes a virtual machine template.
DELETE /ovirt-engine/api/templates/123
25739 25740 25741 |
# File 'lib/ovirtsdk4/services.rb', line 25739 def remove(opts = {}) internal_remove(REMOVE, opts) end |
#service(path) ⇒ Service
Locates the service corresponding to the given path.
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 |
# File 'lib/ovirtsdk4/services.rb', line 25950 def service(path) if path.nil? || path == '' return self end if path == 'cdroms' return cdroms_service end if path.start_with?('cdroms/') return cdroms_service.service(path[7..-1]) end if path == 'diskattachments' return end if path.start_with?('diskattachments/') return .service(path[16..-1]) end if path == 'graphicsconsoles' return graphics_consoles_service end if path.start_with?('graphicsconsoles/') return graphics_consoles_service.service(path[17..-1]) end if path == 'nics' return nics_service end if path.start_with?('nics/') return nics_service.service(path[5..-1]) end if path == 'permissions' return end if path.start_with?('permissions/') return .service(path[12..-1]) end if path == 'tags' return end if path.start_with?('tags/') return .service(path[5..-1]) end if path == 'watchdogs' return watchdogs_service end if path.start_with?('watchdogs/') return watchdogs_service.service(path[10..-1]) end raise Error.new("The path \"#{path}\" doesn't correspond to any service") end |
#tags_service ⇒ AssignedTagsService
Returns a reference to the service that manages the tags that are associated with the template.
25930 25931 25932 |
# File 'lib/ovirtsdk4/services.rb', line 25930 def @tags_service ||= AssignedTagsService.new(self, 'tags') end |
#update(template, opts = {}) ⇒ Template
Updates the template.
The name
, description
, type
, memory
, cpu
, topology
, os
, high_availability
, display
,
stateless
, usb
, and timezone
elements can be updated after a template has been created.
For example, to update a template so that it has 1 GiB of memory send a request like this:
PUT /ovirt-engine/api/templates/123
With the following request body:
<template>
<memory>1073741824</memory>
</template>
The version_name
name attribute is the only one that can be updated within the version
attribute used for
template versions:
<template>
<version>
<version_name>mytemplate_2</version_name>
</version>
</template>
25875 25876 25877 |
# File 'lib/ovirtsdk4/services.rb', line 25875 def update(template, opts = {}) internal_update(template, Template, UPDATE, opts) end |
#watchdogs_service ⇒ TemplateWatchdogsService
Returns a reference to the service that manages the watchdogs that are associated with the template.
25939 25940 25941 |
# File 'lib/ovirtsdk4/services.rb', line 25939 def watchdogs_service @watchdogs_service ||= TemplateWatchdogsService.new(self, 'watchdogs') end |