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

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

Overview

Register templates from an URL. Create templates from a ROOT volume of a stopped VM or its snapshot. Update (since version 2.7), 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, fix_inclusion, #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.



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

attribute :account

#bits ⇒ 32, ...

Returns 32 or 64 bits support.

Returns:

  • (32, 64, nil) —

    32 or 64 bits support.



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

attribute :bits

#checksum ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :checksum

#cross_zones ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

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



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

attribute :cross_zones

#details ⇒ Object?

Returns Template details in key/value pairs.

Returns:

  • (Object, nil) —

    Template details in key/value pairs.



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

attribute :details

#display_text ⇒ String?

Returns Display text of the template.

Returns:

  • (String, nil) —

    Display text of the template.



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

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.



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

attribute :domain

#format ⇒ :QCOW2, ...

Returns The format for the template.,Only considered if I(state=present).

Returns:

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

    The format for the template.,Only considered if I(state=present).



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

attribute :format

#hypervisor ⇒ :KVM, ...

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

Returns:

  • (:KVM, :kvm, :VMware, :vmware, :BareMetal, :baremetal, :XenServer, :xenserver, :LXC, :lxc, :HyperV, :hyperv, :UCS, :ucs, :OVM, :ovm, :Simulator, :simulator, nil) —

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



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

attribute :hypervisor

#is_dynamically_scalable ⇒ Symbol?

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:

  • (Symbol, 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.



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

attribute :is_dynamically_scalable

#is_extractable ⇒ Symbol?

Returns Allows the template or its derivatives to be extractable.

Returns:

  • (Symbol, nil) —

    Allows the template or its derivatives to be extractable.



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

attribute :is_extractable

#is_featured ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

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



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

attribute :is_featured

#is_public ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

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



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

attribute :is_public

#is_ready ⇒ Symbol?

Returns Note: this flag was not implemented and therefore marked as deprecated.,Deprecated, will be removed in version 2.11.

Returns:

  • (Symbol, nil) —

    Note: this flag was not implemented and therefore marked as deprecated.,Deprecated, will be removed in version 2.11.



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

attribute :is_ready

#is_routing ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

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



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

attribute :is_routing

#mode ⇒ :http_download, ...

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

Returns:

  • (:http_download, :ftp_upload, nil) —

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



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

attribute :mode

#name ⇒ String

Returns Name of the template.

Returns:

  • (String) —

    Name of the template.



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

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.



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

attribute :os_type

#password_enabled ⇒ Symbol?

Returns Enable template password reset support.

Returns:

  • (Symbol, nil) —

    Enable template password reset support.



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

attribute :password_enabled

#poll_async ⇒ Boolean?

Returns Poll async jobs until job has finished.

Returns:

  • (Boolean, nil) —

    Poll async jobs until job has finished.



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

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.



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

attribute :project

#requires_hvm ⇒ Symbol?

Returns Whether the template requires HVM or not.,Only considered while creating the template.

Returns:

  • (Symbol, nil) —

    Whether the template requires HVM or not.,Only considered while creating the template.



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

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.



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

attribute :snapshot

#sshkey_enabled ⇒ Symbol?

Returns True if the template supports the sshkey upload feature.,Only considered if C(url) is used (API limitation).

Returns:

  • (Symbol, nil) —

    True if the template supports the sshkey upload feature.,Only considered if C(url) is used (API limitation).



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

attribute :sshkey_enabled

#state ⇒ :present, ...

Returns State of the template.

Returns:

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

    State of the template.



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

attribute :state

#tags ⇒ Object?

Returns List of tags. Tags are a list of dictionaries having keys C(key) and C(value).,To delete all tags, set a empty list e.g. C(tags: []).

Returns:

  • (Object, nil) —

    List of tags. Tags are a list of dictionaries having keys C(key) and C(value).,To delete all tags, set a empty list e.g. C(tags: []).



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

attribute :tags

#template_filter ⇒ :all, ...

Returns Name of the filter used to search for the template.,The filter C(all) was added in 2.7.

Returns:

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

    Name of the filter used to search for the template.,The filter C(all) was added in 2.7.



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

attribute :template_filter

#template_find_options ⇒ :display_text, ...

Returns Options to find a template uniquely.,More than one allowed.

Returns:

  • (:display_text, :checksum, :cross_zones, nil) —

    Options to find a template uniquely.,More than one allowed.



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

attribute :template_find_options

#template_tag ⇒ Object?

Returns The tag for this template.

Returns:

  • (Object, nil) —

    The tag for this template.



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

attribute :template_tag

#url ⇒ String?

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

Returns:

  • (String, nil) —

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



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

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



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

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.



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

attribute :zone