Class: Ansible::Ruby::Modules::Cs_template

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb

Overview

Register a template from URL, create a template from a ROOT volume of a stopped VM or its snapshot, extract and delete templates.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#account ⇒ Object?

Returns Account the template, snapshot or VM is related to.

Returns:

  • (Object, nil) —

    Account the template, snapshot or VM is related to.



62
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 62

attribute :account

#bits ⇒ String?

Returns 32 or 64 bits support.

Returns:

  • (String, nil) —

    32 or 64 bits support.



110
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 110

attribute :bits

#checksum ⇒ Boolean?

Returns The MD5 checksum value of this template.,If set, we search by checksum instead of name.

Returns:

  • (Boolean, nil) —

    The MD5 checksum value of this template.,If set, we search by checksum instead of name.



31
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 31

attribute :checksum

#cross_zones ⇒ Boolean?

Returns Whether the template should be syned or removed across zones.,Only used if C(state) is present or absent.

Returns:

  • (Boolean, nil) —

    Whether the template should be syned or removed across zones.,Only used if C(state) is present or absent.



51
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 51

attribute :cross_zones

#details ⇒ Object?

Returns Template details in key/value pairs.

Returns:

  • (Object, nil) —

    Template details in key/value pairs.



107
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 107

attribute :details

#display_text ⇒ Object?

Returns Display text of the template.

Returns:

  • (Object, nil) —

    Display text of the template.



114
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 114

attribute :display_text

#domain ⇒ Object?

Returns Domain the template, snapshot or VM is related to.

Returns:

  • (Object, nil) —

    Domain the template, snapshot or VM is related to.



59
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 59

attribute :domain

#format ⇒ :QCOW2, ...

Returns The format for the template.,Relevant when using C(state=present).

Returns:

  • (:QCOW2, :RAW, :VHD, :OVA, nil) —

    The format for the template.,Relevant when using C(state=present).



99
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 99

attribute :format

#hypervisor ⇒ :KVM, ...

Returns Name the hypervisor to be used for creating the new template.,Relevant when using C(state=present).

Returns:

  • (:KVM, :VMware, :BareMetal, :XenServer, :LXC, :HyperV, :UCS, :OVM, nil) —

    Name the hypervisor to be used for creating the new template.,Relevant when using C(state=present).



76
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 76

attribute :hypervisor

#is_dynamically_scalable ⇒ Boolean?

Returns Register the template having XS/VMWare tools installed in order to support dynamic scaling of VM CPU/memory.,Only used if C(state) is present.

Returns:

  • (Boolean, nil) —

    Register the template having XS/VMWare tools installed in order to support dynamic scaling of VM CPU/memory.,Only used if C(state) is present.



47
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 47

attribute :is_dynamically_scalable

#is_extractable ⇒ Boolean?

Returns True if the template or its derivatives are extractable.

Returns:

  • (Boolean, nil) —

    True if the template or its derivatives are extractable.



103
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 103

attribute :is_extractable

#is_featured ⇒ Boolean?

Returns Register the template to be featured.,Only used if C(state) is present.

Returns:

  • (Boolean, nil) —

    Register the template to be featured.,Only used if C(state) is present.



43
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 43

attribute :is_featured

#is_public ⇒ Boolean?

Returns Register the template to be publicly available to all users.,Only used if C(state) is present.

Returns:

  • (Boolean, nil) —

    Register the template to be publicly available to all users.,Only used if C(state) is present.



39
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 39

attribute :is_public

#is_ready ⇒ Boolean?

Returns This flag is used for searching existing templates.,If set to C(true), it will only list template ready for deployment e.g. successfully downloaded and installed.,Recommended to set it to C(false).

Returns:

  • (Boolean, nil) —

    This flag is used for searching existing templates.,If set to C(true), it will only list template ready for deployment e.g. successfully downloaded and installed.,Recommended to set it to C(false).



35
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 35

attribute :is_ready

#is_routing ⇒ Boolean?

Returns True if the template type is routing i.e., if template is used to deploy router.,Only considered if C(url) is used.

Returns:

  • (Boolean, nil) —

    True if the template type is routing i.e., if template is used to deploy router.,Only considered if C(url) is used.



95
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 95

attribute :is_routing

#mode ⇒ :http_download, ...

Returns Mode for the template extraction.,Only used if C(state=extracted).

Returns:

  • (:http_download, :ftp_upload, nil) —

    Mode for the template extraction.,Only used if C(state=extracted).



55
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 55

attribute :mode

#name ⇒ String

Returns Name of the template.

Returns:

  • (String) —

    Name of the template.



11
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 11

attribute :name

#os_type ⇒ String?

Returns OS type that best represents the OS of this template.

Returns:

  • (String, nil) —

    OS type that best represents the OS of this template.



27
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 27

attribute :os_type

#password_enabled ⇒ Boolean?

Returns True if the template supports the password reset feature.

Returns:

  • (Boolean, nil) —

    True if the template supports the password reset feature.



84
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 84

attribute :password_enabled

#poll_async ⇒ Boolean?

Returns Poll async jobs until job has finished.

Returns:

  • (Boolean, nil) —

    Poll async jobs until job has finished.



121
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 121

attribute :poll_async

#project ⇒ Object?

Returns Name of the project the template to be registered in.

Returns:

  • (Object, nil) —

    Name of the project the template to be registered in.



65
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 65

attribute :project

#requires_hvm ⇒ Boolean?

Returns true if this template requires HVM.

Returns:

  • (Boolean, nil) —

    true if this template requires HVM.



80
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 80

attribute :requires_hvm

#snapshot ⇒ String?

Returns Name of the snapshot, created from the VM ROOT volume, the template will be created from.,C(vm) is required together with this argument.

Returns:

  • (String, nil) —

    Name of the snapshot, created from the VM ROOT volume, the template will be created from.,C(vm) is required together with this argument.



23
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 23

attribute :snapshot

#sshkey_enabled ⇒ Boolean?

Returns True if the template supports the sshkey upload feature.

Returns:

  • (Boolean, nil) —

    True if the template supports the sshkey upload feature.



91
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 91

attribute :sshkey_enabled

#state ⇒ :present, ...

Returns State of the template.

Returns:

  • (:present, :absent, :extacted, nil) —

    State of the template.



117
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 117

attribute :state

#template_filter ⇒ :featured, ...

Returns Name of the filter used to search for the template.

Returns:

  • (:featured, :self, :selfexecutable, :sharedexecutable, :executable, :community, nil) —

    Name of the filter used to search for the template.



72
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 72

attribute :template_filter

#template_tag ⇒ Object?

Returns the tag for this template.

Returns:

  • (Object, nil) —

    the tag for this template.



88
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 88

attribute :template_tag

#url ⇒ String?

Returns URL of where the template is hosted on C(state=present).,URL to which the template would be extracted on C(state=extracted).,Mutually exclusive with C(vm).

Returns:

  • (String, nil) —

    URL of where the template is hosted on C(state=present).,URL to which the template would be extracted on C(state=extracted).,Mutually exclusive with C(vm).



15
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 15

attribute :url

#vm ⇒ String?

Returns VM name the template will be created from its volume or alternatively from a snapshot.,VM must be in stopped state if created from its volume.,Mutually exclusive with C(url).

Returns:

  • (String, nil) —

    VM name the template will be created from its volume or alternatively from a snapshot.,VM must be in stopped state if created from its volume.,Mutually exclusive with C(url).



19
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 19

attribute :vm

#zone ⇒ String?

Returns Name of the zone you wish the template to be registered or deleted from.,If not specified, first found zone will be used.

Returns:

  • (String, nil) —

    Name of the zone you wish the template to be registered or deleted from.,If not specified, first found zone will be used.



68
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_template.rb', line 68

attribute :zone