Class: Ansible::Ruby::Modules::Bigip_gtm_virtual_server

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

Overview

Manages F5 BIG-IP GTM virtual servers. A GTM server can have many virtual servers associated with it. They are arranged in much the same way that pool members are to pools.

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

#address ⇒ Object?

Returns Specifies the IP Address of the virtual server.,When creating a new GTM virtual server, this parameter is required.

Returns:

  • (Object, nil) —

    Specifies the IP Address of the virtual server.,When creating a new GTM virtual server, this parameter is required.



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

attribute :address

#availability_requirements ⇒ Object?

Returns Specifies, if you activate more than one health monitor, the number of health monitors that must receive successful responses in order for the link to be considered available.

Returns:

  • (Object, nil) —

    Specifies, if you activate more than one health monitor, the number of health monitors that must receive successful responses in order for the link to be considered available.



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

attribute :availability_requirements

#limits ⇒ Object?

Returns Specifies resource thresholds or limit requirements at the server level.,When you enable one or more limit settings, the system then uses that data to take servers in and out of service.,You can define limits for any or all of the limit settings. However, when a server does not meet the resource threshold limit requirement, the system marks the entire server as unavailable and directs load-balancing traffic to another resource.,The limit settings available depend on the type of server.

Returns:

  • (Object, nil) —

    Specifies resource thresholds or limit requirements at the server level.,When you enable one or more limit settings, the system then uses that data to take servers in and out of service.,You can define limits for any or all of the limit settings. However, when a server does not meet the resource threshold limit requirement, the system marks the entire server as unavailable and directs load-balancing traffic to another resource.,The limit settings available depend on the type of server.



44
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_virtual_server.rb', line 44

attribute :limits

#link ⇒ Object?

Returns Specifies a link to assign to the server or virtual server.

Returns:

  • (Object, nil) —

    Specifies a link to assign to the server or virtual server.



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

attribute :link

#monitors ⇒ Object?

Returns Specifies the health monitors that the system currently uses to monitor this resource.,When C(availability_requirements.type) is C(require), you may only have a single monitor in the C(monitors) list.

Returns:

  • (Object, nil) —

    Specifies the health monitors that the system currently uses to monitor this resource.,When C(availability_requirements.type) is C(require), you may only have a single monitor in the C(monitors) list.



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

attribute :monitors

#name ⇒ String?

Returns Specifies the name of the virtual server.

Returns:

  • (String, nil) —

    Specifies the name of the virtual server.



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

attribute :name

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



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

attribute :partition

#port ⇒ Object?

Returns Specifies the service port number for the virtual server or pool member. For example, the HTTP service is typically port 80.,To specify all ports, use an C(*).,When creating a new GTM virtual server, if this parameter is not specified, a default of C(*) will be used.

Returns:

  • (Object, nil) —

    Specifies the service port number for the virtual server or pool member. For example, the HTTP service is typically port 80.,To specify all ports, use an C(*).,When creating a new GTM virtual server, if this parameter is not specified, a default of C(*) will be used.



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

attribute :port

#server_name ⇒ String?

Returns Specifies the name of the server that the virtual server is associated with.

Returns:

  • (String, nil) —

    Specifies the name of the server that the virtual server is associated with.



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

attribute :server_name

#state ⇒ :present, ...

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

Returns:

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

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



51
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_virtual_server.rb', line 51

attribute :state

#translation_address ⇒ Object?

Returns Specifies the translation IP address for the virtual server.,To unset this parameter, provide an empty string (C(“”)) as a value.,When creating a new GTM virtual server, if this parameter is not specified, a default of C(::) will be used.

Returns:

  • (Object, nil) —

    Specifies the translation IP address for the virtual server.,To unset this parameter, provide an empty string (C(“”)) as a value.,When creating a new GTM virtual server, if this parameter is not specified, a default of C(::) will be used.



26
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_virtual_server.rb', line 26

attribute :translation_address

#translation_port ⇒ Object?

Returns Specifies the translation port number or service name for the virtual server.,To specify all ports, use an C(*).,When creating a new GTM virtual server, if this parameter is not specified, a default of C(*) will be used.

Returns:

  • (Object, nil) —

    Specifies the translation port number or service name for the virtual server.,To specify all ports, use an C(*).,When creating a new GTM virtual server, if this parameter is not specified, a default of C(*) will be used.



29
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_virtual_server.rb', line 29

attribute :translation_port

#virtual_server_dependencies ⇒ Object?

Returns Specifies the virtual servers on which the current virtual server depends.,If any of the specified servers are unavailable, the current virtual server is also listed as unavailable.

Returns:

  • (Object, nil) —

    Specifies the virtual servers on which the current virtual server depends.,If any of the specified servers are unavailable, the current virtual server is also listed as unavailable.



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

attribute :virtual_server_dependencies