Class: Ansible::Ruby::Modules::Bigip_iapp_template

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/f5/bigip_iapp_template.rb

Overview

Manages TCL iApp templates on a BIG-IP. This module will allow you to deploy iApp templates to the BIG-IP and manage their lifecycle. The conventional way to use this module is to import new iApps as needed or by extracting the contents of the iApp archive that is provided at downloads.f5.com and then importing all the iApps with this module. This module can also update existing iApps provided that the source of the iApp changed while the name stayed the same. Note however that this module will not reconfigure any services that may have been created using the C(bigip_iapp_service) module. iApps are normally not updated in production. Instead, new versions are deployed and then existing services are changed to consume that new template. As such, the ability to update templates in-place requires the C(force) option to be used.

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

#content ⇒ String?

Returns Sets the contents of an iApp template directly to the specified value. This is for simple values, but can be used with lookup plugins for anything complex or with formatting. C(content) must be provided when creating new templates.

Returns:

  • (String, nil) —

    Sets the contents of an iApp template directly to the specified value. This is for simple values, but can be used with lookup plugins for anything complex or with formatting. C(content) must be provided when creating new templates.



19
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_iapp_template.rb', line 19

attribute :content

#force ⇒ Symbol?

Returns Specifies whether or not to force the uploading of an iApp. When C(yes), will force update the iApp even if there are iApp services using it. This will not update the running service though. Use C(bigip_iapp_service) to do that. When C(no), will update the iApp only if there are no iApp services using the template.

Returns:

  • (Symbol, nil) —

    Specifies whether or not to force the uploading of an iApp. When C(yes), will force update the iApp even if there are iApp services using it. This will not update the running service though. Use C(bigip_iapp_service) to do that. When C(no), will update the iApp only if there are no iApp services using the template.



12
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_iapp_template.rb', line 12

attribute :force

#name ⇒ Object?

Returns The name of the iApp template that you want to delete. This option is only available when specifying a C(state) of C(absent) and is provided as a way to delete templates that you may no longer have the source of.

Returns:

  • (Object, nil) —

    The name of the iApp template that you want to delete. This option is only available when specifying a C(state) of C(absent) and is provided as a way to delete templates that you may no longer have the source of.



16
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_iapp_template.rb', line 16

attribute :name

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



27
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_iapp_template.rb', line 27

attribute :partition

#state ⇒ :present, ...

Returns Whether the iApp template should exist or not.

Returns:

  • (:present, :absent, nil) —

    Whether the iApp template should exist or not.



23
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_iapp_template.rb', line 23

attribute :state