Class: Ansible::Ruby::Modules::Bigip_profile_udp

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

Overview

Manage UDP profiles on a BIG-IP. Many of UDP profiles exist; each with their own adjustments to the standard C(udp) profile. Users of this module should be aware that many of the adjustable knobs have no module default. Instead, the default is assigned by the BIG-IP system itself which, in most cases, is acceptable.

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

#datagram_load_balancing ⇒ Symbol?

Returns Specifies, when C(yes), that the system load balances UDP traffic packet-by-packet.

Returns:

  • (Symbol, nil) —

    Specifies, when C(yes), that the system load balances UDP traffic packet-by-packet.



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

attribute :datagram_load_balancing

#idle_timeout ⇒ Integer?

Returns Specifies the length of time that a connection is idle (has no traffic) before the connection is eligible for deletion.,When creating a new profile, if this parameter is not specified, the remote device will choose a default value appropriate for the profile, based on its C(parent) profile.,When a number is specified, indicates the number of seconds that the UDP connection can remain idle before the system deletes it.,When C(0), or C(indefinite), specifies that UDP connections can remain idle indefinitely.,When C(immediate), specifies that you do not want the UDP connection to remain idle, and that it is therefore immediately eligible for deletion.

Returns:

  • (Integer, nil) —

    Specifies the length of time that a connection is idle (has no traffic) before the connection is eligible for deletion.,When creating a new profile, if this parameter is not specified, the remote device will choose a default value appropriate for the profile, based on its C(parent) profile.,When a number is specified, indicates the number of seconds that the UDP connection can remain idle before the system deletes it.,When C(0), or C(indefinite), specifies that UDP connections can remain idle indefinitely.,When C(immediate), specifies that you do not want the UDP connection to remain idle, and that it is therefore immediately eligible for deletion.



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

attribute :idle_timeout

#name ⇒ String

Returns Specifies the name of the profile.

Returns:

  • (String) —

    Specifies the name of the profile.



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

attribute :name

#parent ⇒ String?

Returns Specifies the profile from which this profile inherits settings.,When creating a new profile, if this parameter is not specified, the default is the system-supplied C(udp) profile.

Returns:

  • (String, nil) —

    Specifies the profile from which this profile inherits settings.,When creating a new profile, if this parameter is not specified, the default is the system-supplied C(udp) profile.



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

attribute :parent

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



28
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_udp.rb', line 28

attribute :partition

#state ⇒ :present, ...

Returns When C(present), ensures that the profile exists.,When C(absent), ensures the profile is removed.

Returns:

  • (:present, :absent, nil) —

    When C(present), ensures that the profile exists.,When C(absent), ensures the profile is removed.



32
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_udp.rb', line 32

attribute :state