Class: Ansible::Ruby::Modules::Bigip_profile_http

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

Overview

Manage HTTP 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

#descriptionObject?

Returns Description of the profile.

Returns:

  • (Object, nil)

    Description of the profile.



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

attribute :description

#dns_resolverObject?

Returns Specifies the name of a configured DNS resolver, this option is mandatory when C(proxy_type) is set to C(explicit).,Format of the name can be either be prepended by partition (C(/Common/foo)), or specified just as an object name (C(foo)).,To remove the entry a value of C(none) or C(”) can be set, however the profile C(proxy_type) must not be set as C(explicit).

Returns:

  • (Object, nil)

    Specifies the name of a configured DNS resolver, this option is mandatory when C(proxy_type) is set to C(explicit).,Format of the name can be either be prepended by partition (C(/Common/foo)), or specified just as an object name (C(foo)).,To remove the entry a value of C(none) or C(”) can be set, however the profile C(proxy_type) must not be set as C(explicit).



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

attribute :dns_resolver

Returns Passphrase for cookie encryption.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.

Returns:

  • (Object, nil)

    Passphrase for cookie encryption.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.



42
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_http.rb', line 42

attribute :encrypt_cookie_secret

#encrypt_cookiesArray<String>, ...

Returns Cookie names for the system to encrypt.,To remove the entry completely a value of C(none) or C(”) should be set.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.

Returns:

  • (Array<String>, String, nil)

    Cookie names for the system to encrypt.,To remove the entry completely a value of C(none) or C(”) should be set.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.



38
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_http.rb', line 38

attribute :encrypt_cookies

#insert_xforwarded_forSymbol?

Returns When specified system inserts an X-Forwarded-For header in an HTTP request with the client IP address, to use with connection pooling.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.

Returns:

  • (Symbol, nil)

    When specified system inserts an X-Forwarded-For header in an HTTP request with the client IP address, to use with connection pooling.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.



30
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_http.rb', line 30

attribute :insert_xforwarded_for

#nameString

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_http.rb', line 12

attribute :name

#parentString?

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



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

attribute :parent

#partitionString?

Returns Device partition to manage resources on.

Returns:

  • (String, nil)

    Device partition to manage resources on.



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

attribute :partition

#proxy_type:reverse, ...

Returns Specifies the proxy mode for the profile.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.

Returns:

  • (:reverse, :transparent, :explicit, nil)

    Specifies the proxy mode for the profile.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.



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

attribute :proxy_type

#redirect_rewrite:none, ...

Returns Specifies whether the system rewrites the URIs that are part of HTTP redirect (3XX) responses.,When set to C(none) the system will not rewrite the URI in any HTTP redirect responses.,When set to C(all) the system rewrites the URI in all HTTP redirect responses.,When set to C(matching) the system rewrites the URI in any HTTP redirect responses that match the request URI.,When set to C(nodes) if the URI contains a node IP address instead of a host name, the system changes it to the virtual server address.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.

Returns:

  • (:none, :all, :matching, :nodes, nil)

    Specifies whether the system rewrites the URIs that are part of HTTP redirect (3XX) responses.,When set to C(none) the system will not rewrite the URI in any HTTP redirect responses.,When set to C(all) the system rewrites the URI in all HTTP redirect responses.,When set to C(matching) the system rewrites the URI in any HTTP redirect responses that match the request URI.,When set to C(nodes) if the URI contains a node IP address instead of a host name, the system changes it to the virtual server address.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.



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

attribute :redirect_rewrite

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



53
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_http.rb', line 53

attribute :state

#update_password:always, ...

Returns C(always) will update passwords if the C(encrypt_cookie_secret) is specified.,C(on_create) will only set the password for newly created profiles.

Returns:

  • (:always, :on_create, nil)

    C(always) will update passwords if the C(encrypt_cookie_secret) is specified.,C(on_create) will only set the password for newly created profiles.



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

attribute :update_password