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/extras/network/f5/bigip_virtual_server.rb

Overview

Manages F5 BIG-IP LTM virtual servers via iControl SOAP API

Instance Method Summary

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

  List of all Profiles (HTTP,ClientSSL,ServerSSL,etc) that must be used by the virtual server.

• #default_persistence_profile ⇒ Object^?

  Default Profile which manages the session persistence.

• #description ⇒ String^?

  Virtual server description.

• #destination ⇒ String

  Destination IP of the virtual server (only host is currently supported) .

• #name ⇒ String

  Virtual server name.

• #partition ⇒ String^?

  Partition.

• #password ⇒ String

  BIG-IP password.

• #pool ⇒ String^?

  Default pool for the virtual server.

• #port ⇒ Integer^?

  Port of the virtual server .

• #server ⇒ String

  BIG-IP host.

• #snat ⇒ String^?

  Source network address policy.

• #state ⇒ :present, ...

  Virtual Server state,Absent, delete the VS if present,present (and its synonym enabled), create if needed the VS and set state to enabled,disabled, create if needed the VS and set state to disabled.

• #user ⇒ String

  BIG-IP username.

• #validate_certs ⇒ :yes, ...

  If C(no), SSL certificates will not be validated.

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

#all_profiles ⇒ Array<String>, ...

Returns List of all Profiles (HTTP,ClientSSL,ServerSSL,etc) that must be used by the virtual server.

Returns:

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

  List of all Profiles (HTTP,ClientSSL,ServerSSL,etc) that must be used by the virtual server

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

attribute :all_profiles

#default_persistence_profile ⇒ Object^?

Returns Default Profile which manages the session persistence.

Returns:

• (Object, nil) —

  Default Profile which manages the session persistence

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

attribute :default_persistence_profile

#description ⇒ String^?

Returns Virtual server description.

Returns:

• (String, nil) —

  Virtual server description.

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

attribute :description

#destination ⇒ String

Returns Destination IP of the virtual server (only host is currently supported) . Required when state=present and vs does not exist.

Returns:

• (String) —

  Destination IP of the virtual server (only host is currently supported) . Required when state=present and vs does not exist.

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

attribute :destination

#name ⇒ String

Returns Virtual server name.

Returns:

• (String) —

  Virtual server name.

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

attribute :name

#partition ⇒ String^?

Returns Partition.

Returns:

• (String, nil) —

  Partition

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

attribute :partition

#password ⇒ String

Returns BIG-IP password.

Returns:

• (String) —

  BIG-IP password

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

attribute :password

#pool ⇒ String^?

Returns Default pool for the virtual server.

Returns:

• (String, nil) —

  Default pool for the virtual server

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

attribute :pool

#port ⇒ Integer^?

Returns Port of the virtual server . Required when state=present and vs does not exist.

Returns:

• (Integer, nil) —

  Port of the virtual server . Required when state=present and vs does not exist

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

attribute :port

#server ⇒ String

Returns BIG-IP host.

Returns:

• (String) —

  BIG-IP host

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

attribute :server

#snat ⇒ String^?

Returns Source network address policy.

Returns:

• (String, nil) —

  Source network address policy

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

attribute :snat

#state ⇒ :present, ...

Returns Virtual Server state,Absent, delete the VS if present,present (and its synonym enabled), create if needed the VS and set state to enabled,disabled, create if needed the VS and set state to disabled.

Returns:

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

  Virtual Server state,Absent, delete the VS if present,present (and its synonym enabled), create if needed the VS and set state to enabled,disabled, create if needed the VS and set state to disabled

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

attribute :state

#user ⇒ String

Returns BIG-IP username.

Returns:

• (String) —

  BIG-IP username

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

attribute :user

#validate_certs ⇒ :yes, ...

Returns If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Returns:

• (:yes, :no, nil) —

  If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

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

attribute :validate_certs