Class: Ansible::Ruby::Modules::Bigip_profile_oneconnect

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

Overview

Manage OneConnect profiles on a BIG-IP.

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

Returns:

  • (Object, nil) —

    Description of the profile.



22
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_oneconnect.rb', line 22

attribute :description

#idle_timeout_override ⇒ Object?

Returns Specifies the number of seconds that a connection is idle before the connection flow is eligible for deletion.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.,You may specify a number of seconds for the timeout override.,When C(disabled), specifies that there is no timeout override for the connection.,When C(indefinite), Specifies that a connection may be idle with no timeout override.

Returns:

  • (Object, nil) —

    Specifies the number of seconds that a connection is idle before the connection flow is eligible for deletion.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.,You may specify a number of seconds for the timeout override.,When C(disabled), specifies that there is no timeout override for the connection.,When C(indefinite), Specifies that a connection may be idle with no timeout override.



34
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_oneconnect.rb', line 34

attribute :idle_timeout_override

#limit_type ⇒ :none, ...

Returns When C(none), simultaneous in-flight requests and responses over TCP connections to a pool member are counted toward the limit. This is the historical behavior.,When C(idle), idle connections will be dropped as the TCP connection limit is reached. For short intervals, during the overlap of the idle connection being dropped and the new connection being established, the TCP connection limit may be exceeded.,When C(strict), the TCP connection limit is honored with no exceptions. This means that idle connections will prevent new TCP connections from being made until they expire, even if they could otherwise be reused.,C(strict) is not a recommended configuration except in very special cases with short expiration timeouts.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.

Returns:

  • (:none, :idle, :strict, nil) —

    When C(none), simultaneous in-flight requests and responses over TCP connections to a pool member are counted toward the limit. This is the historical behavior.,When C(idle), idle connections will be dropped as the TCP connection limit is reached. For short intervals, during the overlap of the idle connection being dropped and the new connection being established, the TCP connection limit may be exceeded.,When C(strict), the TCP connection limit is honored with no exceptions. This means that idle connections will prevent new TCP connections from being made until they expire, even if they could otherwise be reused.,C(strict) is not a recommended configuration except in very special cases with short expiration timeouts.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.



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

attribute :limit_type

#maximum_age ⇒ Object?

Returns Specifies the maximum number of seconds allowed for a connection in the connection reuse pool.,For any connection with an age higher than this value, the system removes that connection from the re-use pool.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.

Returns:

  • (Object, nil) —

    Specifies the maximum number of seconds allowed for a connection in the connection reuse pool.,For any connection with an age higher than this value, the system removes that connection from the re-use pool.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.



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

attribute :maximum_age

#maximum_reuse ⇒ Object?

Returns Specifies the maximum number of times that a server-side connection can be reused.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.

Returns:

  • (Object, nil) —

    Specifies the maximum number of times that a server-side connection can be reused.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.



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

attribute :maximum_reuse

#maximum_size ⇒ Object?

Returns Specifies the maximum number of connections that the system holds in the connection reuse pool.,If the pool is already full, then a server-side connection closes after the response is completed.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.

Returns:

  • (Object, nil) —

    Specifies the maximum number of connections that the system holds in the connection reuse pool.,If the pool is already full, then a server-side connection closes after the response is completed.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.



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

attribute :maximum_size

#name ⇒ String

Returns Specifies the name of the OneConnect profile.

Returns:

  • (String) —

    Specifies the name of the OneConnect profile.



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

attribute :name

#parent ⇒ Object?

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(oneconnect) profile.

Returns:

  • (Object, 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(oneconnect) profile.



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

attribute :parent

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



45
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_oneconnect.rb', line 45

attribute :partition

#share_pools ⇒ Symbol?

Returns Indicates that connections may be shared not only within a virtual server, but also among similar virtual servers,When C(yes), all virtual servers that use the same OneConnect and other internal network profiles can share connections.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.

Returns:

  • (Symbol, nil) —

    Indicates that connections may be shared not only within a virtual server, but also among similar virtual servers,When C(yes), all virtual servers that use the same OneConnect and other internal network profiles can share connections.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.



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

attribute :share_pools

#source_mask ⇒ Object?

Returns Specifies a value that the system applies to the source address to determine its eligibility for reuse.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.,The system applies the value of this setting to the server-side source address to determine its eligibility for reuse.,A mask of C(0) causes the system to share reused connections across all source addresses. A host mask of C(32) causes the system to share only those reused connections originating from the same source address.,When you are using a SNAT or SNAT pool, the server-side source address is translated first and then the OneConnect mask is applied to the translated address.

Returns:

  • (Object, nil) —

    Specifies a value that the system applies to the source address to determine its eligibility for reuse.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.,The system applies the value of this setting to the server-side source address to determine its eligibility for reuse.,A mask of C(0) causes the system to share reused connections across all source addresses. A host mask of C(32) causes the system to share only those reused connections originating from the same source address.,When you are using a SNAT or SNAT pool, the server-side source address is translated first and then the OneConnect mask is applied to the translated address.



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

attribute :source_mask

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



49
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_oneconnect.rb', line 49

attribute :state