Class: Ansible::Ruby::Modules::Bigip_virtual_server

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Bigip_virtual_server

Defined in:

lib/ansible/ruby/modules/generated/network/f5/bigip_virtual_server.rb

Overview

Manage LTM virtual servers on a BIG-IP.

Instance Method Summary

• #address_translation ⇒ Object^?

  Specifies, when C(enabled), that the system translates the address of the virtual server.,When C(disabled), specifies that the system uses the address without translation.,This option is useful when the system is load balancing devices that have the same IP address.,When creating a new virtual server, the default is C(enabled).

• #default_persistence_profile ⇒ Object^?

  Default Profile which manages the session persistence.,If you want to remove the existing default persistence profile, specify an empty value; C(“”).

• #description ⇒ String^?

  Virtual server description.

• #destination ⇒ String^?

  Destination IP of the virtual server.,Required when C(state) is C(present) and virtual server does not exist.,When C(type) is C(internal), this parameter is ignored.

• #disabled_vlans ⇒ Object^?

  List of VLANs to be disabled.

• #enabled_vlans ⇒ Array<String>, ...

  List of VLANs to be enabled.

• #fallback_persistence_profile ⇒ Object^?

  Specifies the persistence profile you want the system to use if it cannot use the specified default persistence profile.,If you want to remove the existing fallback persistence profile, specify an empty value; C(“”).

• #firewall_enforced_policy ⇒ Object^?

  Applies the specify AFM policy to the virtual in an enforcing way.,When creating a new virtual, if this parameter is not specified, the enforced policy is disabled.

• #firewall_staged_policy ⇒ Object^?

  Applies the specify AFM policy to the virtual in an enforcing way.,A staged policy shows the results of the policy rules in the log, while not actually applying the rules to traffic.,When creating a new virtual, if this parameter is not specified, the staged policy is disabled.

• #ip_protocol ⇒ :ah, ...

  Specifies a network protocol name you want the system to use to direct traffic on this virtual server.,When creating a new virtual server, if this parameter is not specified, the default is C(tcp).,The Protocol setting is not available when you select Performance (HTTP) as the Type.,The value of this argument can be specified in either it’s numeric value, or, for convenience, in a select number of named values.

• #irules ⇒ Array<String>, ...

  List of rules to be applied in priority order.,If you want to remove existing iRules, specify a single empty value; C(“”).

• #metadata ⇒ Hash^?

  Arbitrary key/value pairs that you can attach to a pool.

• #name ⇒ String

  Virtual server name.

• #partition ⇒ String^?

  Device partition to manage resources on.

• #policies ⇒ Array<String>, ...

  Specifies the policies for the virtual server.,When C(type) is C(dhcp), this parameter will be ignored.,When C(type) is C(reject), this parameter will be ignored.,When C(type) is C(internal), this parameter will be ignored.

• #pool ⇒ String^?

  Default pool for the virtual server.,If you want to remove the existing pool, specify an empty value; C(“”).

• #port ⇒ Integer^?

  Port of the virtual server.

• #port_translation ⇒ Object^?

  Specifies, when C(enabled), that the system translates the port of the virtual server.,When C(disabled), specifies that the system uses the port without translation.

• #profiles ⇒ Array<String>, ...

  List of profiles (HTTP, ClientSSL, ServerSSL, etc) to apply to both sides of the connection (client-side and server-side).,If you only want to apply a particular profile to the client-side of the connection, specify C(client-side) for the profile’s C(context).,If you only want to apply a particular profile to the server-side of the connection, specify C(server-side) for the profile’s C(context).,If C(context) is not provided, it will default to C(all).,If you want to remove a profile from the list of profiles currently active on the virtual, then simply remove it from the C(profiles) list.

• #security_log_profiles ⇒ Object^?

  Specifies the log profile applied to the virtual server.,To make use of this feature, the AFM module must be licensed and provisioned.,The C(Log all requests) and C(Log illegal requests) are mutually exclusive and therefore, this module will raise an error if the two are specified together.

• #security_nat_policy ⇒ Object^?

  Specify the Firewall NAT policies for the virtual server.,You can specify one or more NAT policies to use.,The most specific policy is used.

• #snat ⇒ String^?

  Source network address policy.,When C(type) is C(dhcp), this parameter is ignored.,When C(type) is C(reject), this parameter will be ignored.,When C(type) is C(internal), this parameter will be ignored.,The name of a SNAT pool (eg “/Common/snat_pool_name”) can be specified to enable SNAT with the specific pool.,To remove SNAT, specify the word C(none).,To specify automap, use the word C(automap).

• #source ⇒ Object^?

  Specifies an IP address or network from which the virtual server accepts traffic.,The virtual server accepts clients only from one of these IP addresses.,For this setting to function effectively, specify a value other than 0.0.0.0/0 or ::/0 (that is, any/0, any6/0).,In order to maximize utility of this setting, specify the most specific address prefixes covering all customer addresses and no others.,Specify the IP address in Classless Inter-Domain Routing (CIDR) format; address/prefix, where the prefix length is in bits.

• #state ⇒ :present, ...

  The virtual server state.

• #type ⇒ :standard, ...

  Specifies the network service provided by this virtual server.,When creating a new virtual server, if this parameter is not provided, the default will be C(standard).,This value cannot be changed after it is set.,When C(standard), specifies a virtual server that directs client traffic to a load balancing pool and is the most basic type of virtual server.

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_translation ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_virtual_server.rb', line 80

attribute :address_translation

#default_persistence_profile ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_virtual_server.rb', line 62

attribute :default_persistence_profile

#description ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_virtual_server.rb', line 65

attribute :description

#destination ⇒ String^?

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

attribute :destination

#disabled_vlans ⇒ Object^?

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

attribute :disabled_vlans

#enabled_vlans ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_virtual_server.rb', line 43

attribute :enabled_vlans

#fallback_persistence_profile ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_virtual_server.rb', line 69

attribute :fallback_persistence_profile

#firewall_enforced_policy ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_virtual_server.rb', line 90

attribute :firewall_enforced_policy

#firewall_staged_policy ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_virtual_server.rb', line 93

attribute :firewall_staged_policy

#ip_protocol ⇒ :ah, ...

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_virtual_server.rb', line 86

attribute :ip_protocol

#irules ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_virtual_server.rb', line 39

attribute :irules

#metadata ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_virtual_server.rb', line 76

attribute :metadata

#name ⇒ String

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

attribute :name

#partition ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_virtual_server.rb', line 72

attribute :partition

#policies ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_virtual_server.rb', line 54

attribute :policies

#pool ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_virtual_server.rb', line 50

attribute :pool

#port ⇒ Integer^?

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

attribute :port

#port_translation ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_virtual_server.rb', line 83

attribute :port_translation

#profiles ⇒ Array<String>, ...

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

attribute :profiles

#security_log_profiles ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_virtual_server.rb', line 96

attribute :security_log_profiles

#security_nat_policy ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_virtual_server.rb', line 99

attribute :security_nat_policy

#snat ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_virtual_server.rb', line 58

attribute :snat

#source ⇒ Object^?

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

attribute :source

#state ⇒ :present, ...

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

attribute :state

#type ⇒ :standard, ...

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

attribute :type