Class: Ansible::Ruby::Modules::Bigip_iapp_service

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

Overview

Manages TCL iApp services on a BIG-IP. If you are looking for the API that is communicated with on the BIG-IP, the one the is used is C(/mgmt/tm/sys/application/service/).

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

#description ⇒ Object?

Returns Description of the iApp service.,If this option is specified in the Ansible task, it will take precedence over any similar setting in the iApp Service payload that you provide in the C(parameters) field.

Returns:

  • (Object, nil) —

    Description of the iApp service.,If this option is specified in the Ansible task, it will take precedence over any similar setting in the iApp Service payload that you provide in the C(parameters) field.



48
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_iapp_service.rb', line 48

attribute :description

#device_group ⇒ Object?

Returns The device group for the iApp service.,If this option is specified in the Ansible task, it will take precedence over any similar setting in the iApp Service payload that you provide in the C(parameters) field.

Returns:

  • (Object, nil) —

    The device group for the iApp service.,If this option is specified in the Ansible task, it will take precedence over any similar setting in the iApp Service payload that you provide in the C(parameters) field.



51
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_iapp_service.rb', line 51

attribute :device_group

#force ⇒ Symbol?

Returns Forces the updating of an iApp service even if the parameters to the service have not changed. This option is of particular importance if the iApp template that underlies the service has been updated in-place. This option is equivalent to re-configuring the iApp if that template has changed.

Returns:

  • (Symbol, nil) —

    Forces the updating of an iApp service even if the parameters to the service have not changed. This option is of particular importance if the iApp template that underlies the service has been updated in-place. This option is equivalent to re-configuring the iApp if that template has changed.



25
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_iapp_service.rb', line 25

attribute :force

#metadata ⇒ Array<Hash>, ...

Returns Metadata associated with the iApp service.,If this option is specified in the Ansible task, it will take precedence over any similar setting in the iApp Service payload that you provide in the C(parameters) field.

Returns:

  • (Array<Hash>, Hash, nil) —

    Metadata associated with the iApp service.,If this option is specified in the Ansible task, it will take precedence over any similar setting in the iApp Service payload that you provide in the C(parameters) field.



44
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_iapp_service.rb', line 44

attribute :metadata

#name ⇒ String

Returns The name of the iApp service that you want to deploy.

Returns:

  • (String) —

    The name of the iApp service that you want to deploy.



13
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_iapp_service.rb', line 13

attribute :name

#parameters ⇒ String, ...

Returns A hash of all the required template variables for the iApp template. If your parameters are stored in a file (the more common scenario) it is recommended you use either the C(file) or C(template) lookups to supply the expected parameters.,These parameters typically consist of the C(lists), C(tables), and C(variables) fields.

Returns:

  • (String, Hash, nil) —

    A hash of all the required template variables for the iApp template. If your parameters are stored in a file (the more common scenario) it is recommended you use either the C(file) or C(template) lookups to supply the expected parameters.,These parameters typically consist of the C(lists), C(tables), and C(variables) fields.



21
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_iapp_service.rb', line 21

attribute :parameters

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



33
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_iapp_service.rb', line 33

attribute :partition

#state ⇒ :present, ...

Returns When C(present), ensures that the iApp service is created and running. When C(absent), ensures that the iApp service has been removed.

Returns:

  • (:present, :absent, nil) —

    When C(present), ensures that the iApp service is created and running. When C(absent), ensures that the iApp service has been removed.



29
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_iapp_service.rb', line 29

attribute :state

#strict_updates ⇒ Boolean?

Returns Indicates whether the application service is tied to the template, so when the template is updated, the application service changes to reflect the updates.,When C(yes), disallows any updates to the resources that the iApp service has created, if they are not updated directly through the iApp.,When C(no), allows updates outside of the iApp.,If this option is specified in the Ansible task, it will take precedence over any similar setting in the iApp Service payload that you provide in the C(parameters) field.

Returns:

  • (Boolean, nil) —

    Indicates whether the application service is tied to the template, so when the template is updated, the application service changes to reflect the updates.,When C(yes), disallows any updates to the resources that the iApp service has created, if they are not updated directly through the iApp.,When C(no), allows updates outside of the iApp.,If this option is specified in the Ansible task, it will take precedence over any similar setting in the iApp Service payload that you provide in the C(parameters) field.



37
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_iapp_service.rb', line 37

attribute :strict_updates

#template ⇒ String?

Returns The iApp template from which to instantiate a new service. This template must exist on your BIG-IP before you can successfully create a service.,When creating a new service, this parameter is required.

Returns:

  • (String, nil) —

    The iApp template from which to instantiate a new service. This template must exist on your BIG-IP before you can successfully create a service.,When creating a new service, this parameter is required.



17
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_iapp_service.rb', line 17

attribute :template

#traffic_group ⇒ Object?

Returns The traffic group for the iApp service. When creating a new service, if this value is not specified, the default of C(/Common/traffic-group-1) will be used.,If this option is specified in the Ansible task, it will take precedence over any similar setting in the iApp Service payload that you provide in the C(parameters) field.

Returns:

  • (Object, nil) —

    The traffic group for the iApp service. When creating a new service, if this value is not specified, the default of C(/Common/traffic-group-1) will be used.,If this option is specified in the Ansible task, it will take precedence over any similar setting in the iApp Service payload that you provide in the C(parameters) field.



41
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_iapp_service.rb', line 41

attribute :traffic_group