Class: Ansible::Ruby::Modules::Bigip_gtm_wide_ip

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

Overview

Manages F5 BIG-IP GTM wide 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, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#aliases ⇒ Object?

Returns Specifies alternate domain names for the web site content you are load balancing.,You can use the same wildcard characters for aliases as you can for actual wide IP names.

Returns:

  • (Object, nil) —

    Specifies alternate domain names for the web site content you are load balancing.,You can use the same wildcard characters for aliases as you can for actual wide IP names.



40
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_wide_ip.rb', line 40

attribute :aliases

#irules ⇒ Array<String>, ...

Returns List of rules to be applied.,If you want to remove all existing iRules, specify a single empty value; C(“”). See the documentation for an example.

Returns:

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

    List of rules to be applied.,If you want to remove all existing iRules, specify a single empty value; C(“”). See the documentation for an example.



36
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_wide_ip.rb', line 36

attribute :irules

#name ⇒ String

Returns Wide IP name. This name must be formatted as a fully qualified domain name (FQDN). You can also use the alias C(wide_ip) but this is deprecated and will be removed in a future Ansible version.

Returns:

  • (String) —

    Wide IP name. This name must be formatted as a fully qualified domain name (FQDN). You can also use the alias C(wide_ip) but this is deprecated and will be removed in a future Ansible version.



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

attribute :name

#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_gtm_wide_ip.rb', line 28

attribute :partition

#pool_lb_method ⇒ :"round-robin", ...

Returns Specifies the load balancing method used to select a pool in this wide IP. This setting is relevant only when multiple pools are configured for a wide IP.,The C(round_robin) value is deprecated and will be removed in Ansible 2.9.,The C(global_availability) value is deprecated and will be removed in Ansible 2.9.

Returns:

  • (:"round-robin", :ratio, :topology, :"global-availability", :global_availability, :round_robin) —

    Specifies the load balancing method used to select a pool in this wide IP. This setting is relevant only when multiple pools are configured for a wide IP.,The C(round_robin) value is deprecated and will be removed in Ansible 2.9.,The C(global_availability) value is deprecated and will be removed in Ansible 2.9.



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

attribute :pool_lb_method

#pools ⇒ Array<Hash>, ...

Returns The pools that you want associated with the Wide IP.,If C(ratio) is not provided when creating a new Wide IP, it will default to 1.

Returns:

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

    The pools that you want associated with the Wide IP.,If C(ratio) is not provided when creating a new Wide IP, it will default to 1.



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

attribute :pools

#state ⇒ :present, ...

Returns When C(present) or C(enabled), ensures that the Wide IP exists and is enabled.,When C(absent), ensures that the Wide IP has been removed.,When C(disabled), ensures that the Wide IP exists and is disabled.

Returns:

  • (:present, :absent, :disabled, :enabled, nil) —

    When C(present) or C(enabled), ensures that the Wide IP exists and is enabled.,When C(absent), ensures that the Wide IP has been removed.,When C(disabled), ensures that the Wide IP exists and is disabled.



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

attribute :state

#type ⇒ :a, ...

Returns Specifies the type of wide IP. GTM wide IPs need to be keyed by query type in addition to name, since pool members need different attributes depending on the response RDATA they are meant to supply. This value is required if you are using BIG-IP versions >= 12.0.0.

Returns:

  • (:a, :aaaa, :cname, :mx, :naptr, :srv, nil) —

    Specifies the type of wide IP. GTM wide IPs need to be keyed by query type in addition to name, since pool members need different attributes depending on the response RDATA they are meant to supply. This value is required if you are using BIG-IP versions >= 12.0.0.



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

attribute :type