Class: Ansible::Ruby::Modules::Bigip_selfip

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

Overview

Manage Self-IPs on a BIG-IP system.

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

#address ⇒ String?

Returns The IP addresses for the new self IP. This value is ignored upon update as addresses themselves cannot be changed after they are created.,This value is required when creating new self IPs.

Returns:

  • (String, nil) —

    The IP addresses for the new self IP. This value is ignored upon update as addresses themselves cannot be changed after they are created.,This value is required when creating new self IPs.



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

attribute :address

#allow_service ⇒ Array<String>, ...

Returns Configure port lockdown for the Self IP. By default, the Self IP has a “default deny” policy. This can be changed to allow TCP and UDP ports as well as specific protocols. This list should contain C(protocol):C(port) values.

Returns:

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

    Configure port lockdown for the Self IP. By default, the Self IP has a “default deny” policy. This can be changed to allow TCP and UDP ports as well as specific protocols. This list should contain C(protocol):C(port) values.



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

attribute :allow_service

#name ⇒ String

Returns The self IP to create.,If this parameter is not specified, then it will default to the value supplied in the C(address) parameter.

Returns:

  • (String) —

    The self IP to create.,If this parameter is not specified, then it will default to the value supplied in the C(address) parameter.



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

attribute :name

#netmask ⇒ String?

Returns The netmask for the self IP. When creating a new Self IP, this value is required.

Returns:

  • (String, nil) —

    The netmask for the self IP. When creating a new Self IP, this value is required.



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

attribute :netmask

#partition ⇒ String?

Returns Device partition to manage resources on. You can set different partitions for Self IPs, but the address used may not match any other address used by a Self IP. In that sense, Self IPs are not isolated by partitions as other resources on a BIG-IP are.

Returns:

  • (String, nil) —

    Device partition to manage resources on. You can set different partitions for Self IPs, but the address used may not match any other address used by a Self IP. In that sense, Self IPs are not isolated by partitions as other resources on a BIG-IP are.



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

attribute :partition

#route_domain ⇒ Integer?

Returns The route domain id of the system. When creating a new Self IP, if this value is not specified, a default value of C(0) will be used.,This value cannot be changed after it is set.

Returns:

  • (Integer, nil) —

    The route domain id of the system. When creating a new Self IP, if this value is not specified, a default value of C(0) will be used.,This value cannot be changed after it is set.



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

attribute :route_domain

#state ⇒ :absent, ...

Returns When C(present), guarantees that the Self-IP exists with the provided attributes.,When C(absent), removes the Self-IP from the system.

Returns:

  • (:absent, :present, nil) —

    When C(present), guarantees that the Self-IP exists with the provided attributes.,When C(absent), removes the Self-IP from the system.



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

attribute :state

#traffic_group ⇒ Object?

Returns The traffic group for the Self IP addresses in an active-active, redundant load balancer configuration. When creating a new Self IP, if this value is not specified, the default of C(/Common/traffic-group-local-only) will be used.

Returns:

  • (Object, nil) —

    The traffic group for the Self IP addresses in an active-active, redundant load balancer configuration. When creating a new Self IP, if this value is not specified, the default of C(/Common/traffic-group-local-only) will be used.



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

attribute :traffic_group

#vlan ⇒ String?

Returns The VLAN that the new self IPs will be on. When creating a new Self IP, this value is required.

Returns:

  • (String, nil) —

    The VLAN that the new self IPs will be on. When creating a new Self IP, this value is required.



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

attribute :vlan