Class: Ansible::Ruby::Modules::Bigip_data_group

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Bigip_data_group

Defined in:

lib/ansible/ruby/modules/generated/network/f5/bigip_data_group.rb

Overview

Allows for managing data groups on a BIG-IP. Data groups provide a way to store collections of values on a BIG-IP for later use in things such as LTM rules, iRules, and ASM policies.

Instance Method Summary

• #delete_data_group_file ⇒ Symbol^?

  When C(yes), will ensure that the remote data group file is deleted.,This parameter is only relevant when C(state) is C(absent) and C(internal) is C(no).

• #external_file_name ⇒ Object^?

  When creating a new data group, this specifies the file name that you want to give an external data group file on the BIG-IP.,This parameter is ignored when C(internal) is C(yes).,This parameter can be used to select an existing data group file to use with an existing external data group.,If this value is not provided, it will be given the value specified in C(name) and, therefore, match the name of the data group.,This value may only contain letters, numbers, underscores, dashes, or a period.

• #internal ⇒ Symbol^?

  The type of this data group.,You should only consider setting this value in cases where you know exactly what you’re doing, B(or), you are working with a pre-existing internal data group.,Be aware that if you deliberately force this parameter to C(yes), and you have a either a large number of records or a large total records size, this large amount of data will be reflected in your BIG-IP configuration.

• #name ⇒ String

  Specifies the name of the data group.

• #partition ⇒ String^?

  Device partition to manage resources on.

• #records ⇒ Array<Hash>, ...

  Specifies the records that you want to add to a data group.,If you have a large number of records, it is recommended that you use C(records_content) instead of typing all those records here.,The technical limit of either 1.

• #records_src ⇒ String^?

  Path to a file with records in it.,The file should be well-formed.

• #separator ⇒ String^?

  When specifying C(records_content), this is the string of characters that will be used to break apart entries in the C(records_content) into key/value pairs.,By default, this parameter’s value is C(:=).,This value cannot be changed once it is set.,This parameter is only relevant when C(internal) is C(no).

• #state ⇒ :present, ...

  When C(state) is C(present), ensures the data group exists.,When C(state) is C(absent), ensures that the data group is removed.

• #type ⇒ :address, ...

  The type of records in this data group.,This parameter is especially important because it causes BIG-IP to store your data in different ways so-as to optimize access to it.

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

#delete_data_group_file ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_data_group.rb', line 39

attribute :delete_data_group_file

#external_file_name ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_data_group.rb', line 24

attribute :external_file_name

#internal ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_data_group.rb', line 20

attribute :internal

#name ⇒ String

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

attribute :name

#partition ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_data_group.rb', line 43

attribute :partition

#records ⇒ Array<Hash>, ...

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

attribute :records

#records_src ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_data_group.rb', line 31

attribute :records_src

#separator ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_data_group.rb', line 35

attribute :separator

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_data_group.rb', line 47

attribute :state

#type ⇒ :address, ...

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

attribute :type