Class: Ansible::Ruby::Modules::Bigip_trunk

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

Overview

Manages trunks on a BIG-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, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

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

Instance Method Details

#description ⇒ Object?

Returns Description of the trunk.

Returns:

  • (Object, nil) —

    Description of the trunk.



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

attribute :description

#frame_distribution_hash ⇒ :"destination-mac", ...

Returns Specifies the basis for the hash that the system uses as the frame distribution algorithm. The system uses the resulting hash to determine which interface to use for forwarding traffic.,When creating a new trunk, if this parameter is not specified, the default is C(source-destination-ip).,When C(source-destination-mac), specifies that the system bases the hash on the combined MAC addresses of the source and the destination.,When C(destination-mac), specifies that the system bases the hash on the MAC address of the destination.,When C(source-destination-ip), specifies that the system bases the hash on the combined IP addresses of the source and the destination.

Returns:

  • (:"destination-mac", :"source-destination-ip", :"source-destination-mac", nil) —

    Specifies the basis for the hash that the system uses as the frame distribution algorithm. The system uses the resulting hash to determine which interface to use for forwarding traffic.,When creating a new trunk, if this parameter is not specified, the default is C(source-destination-ip).,When C(source-destination-mac), specifies that the system bases the hash on the combined MAC addresses of the source and the destination.,When C(destination-mac), specifies that the system bases the hash on the MAC address of the destination.,When C(source-destination-ip), specifies that the system bases the hash on the combined IP addresses of the source and the destination.



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

attribute :frame_distribution_hash

#interfaces ⇒ Array<Float>, ...

Returns The interfaces that are part of the trunk.,To clear the list of interfaces, specify an empty list.

Returns:

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

    The interfaces that are part of the trunk.,To clear the list of interfaces, specify an empty list.



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

attribute :interfaces

#lacp_enabled ⇒ Symbol?

Returns When C(yes), specifies that the system supports the link aggregation control protocol (LACP), which monitors the trunk by exchanging control packets over the member links to determine the health of the links.,If LACP detects a failure in a member link, it removes the link from the link aggregation.,When creating a new trunk, if this parameter is not specified, LACP is C(no).,LACP is disabled by default for backward compatibility. If this does not apply to your network, we recommend that you enable LACP.

Returns:

  • (Symbol, nil) —

    When C(yes), specifies that the system supports the link aggregation control protocol (LACP), which monitors the trunk by exchanging control packets over the member links to determine the health of the links.,If LACP detects a failure in a member link, it removes the link from the link aggregation.,When creating a new trunk, if this parameter is not specified, LACP is C(no).,LACP is disabled by default for backward compatibility. If this does not apply to your network, we recommend that you enable LACP.



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

attribute :lacp_enabled

#lacp_mode ⇒ :active, ...

Returns Specifies the operation mode for link aggregation control protocol (LACP), if LACP is enabled for the trunk.,When creating a new trunk, if this parameter is not specified, the default is C(active).,When C(active), specifies that the system periodically sends control packets regardless of whether the partner system has issued a request.,When C(passive), specifies that the system sends control packets only when the partner system has issued a request.

Returns:

  • (:active, :passive, nil) —

    Specifies the operation mode for link aggregation control protocol (LACP), if LACP is enabled for the trunk.,When creating a new trunk, if this parameter is not specified, the default is C(active).,When C(active), specifies that the system periodically sends control packets regardless of whether the partner system has issued a request.,When C(passive), specifies that the system sends control packets only when the partner system has issued a request.



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

attribute :lacp_mode

#lacp_timeout ⇒ :long, ...

Returns Specifies the rate at which the system sends the LACP control packets.,When creating a new trunk, if this parameter is not specified, the default is C(long).,When C(long), specifies that the system sends an LACP control packet every 30 seconds.,When C(short), specifies that the system sends an LACP control packet every 1 seconds.

Returns:

  • (:long, :short, nil) —

    Specifies the rate at which the system sends the LACP control packets.,When creating a new trunk, if this parameter is not specified, the default is C(long).,When C(long), specifies that the system sends an LACP control packet every 30 seconds.,When C(short), specifies that the system sends an LACP control packet every 1 seconds.



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

attribute :lacp_timeout

#link_selection_policy ⇒ :auto, ...

Returns Specifies, once the trunk is configured, the policy that the trunk uses to determine which member link (interface) can handle new traffic.,When creating a new trunk, if this value is not specific, the default is C(auto).,When C(auto), specifies that the system automatically determines which interfaces can handle new traffic. For the C(auto) option, the member links must all be the same media type and speed.,When C(maximum-bandwidth), specifies that the system determines which interfaces can handle new traffic based on the members’ maximum bandwidth.

Returns:

  • (:auto, :"maximum-bandwidth", nil) —

    Specifies, once the trunk is configured, the policy that the trunk uses to determine which member link (interface) can handle new traffic.,When creating a new trunk, if this value is not specific, the default is C(auto).,When C(auto), specifies that the system automatically determines which interfaces can handle new traffic. For the C(auto) option, the member links must all be the same media type and speed.,When C(maximum-bandwidth), specifies that the system determines which interfaces can handle new traffic based on the members’ maximum bandwidth.



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

attribute :link_selection_policy

#name ⇒ String

Returns Specifies the name of the trunk.

Returns:

  • (String) —

    Specifies the name of the trunk.



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

attribute :name

#qinq_ethertype ⇒ Object?

Returns Specifies the ether-type value used for the packets handled on this trunk when it is a member in a QinQ vlan.,The ether-type can be set to any string containing a valid hexadecimal 16 bits number, or any of the well known ether-types; C(0x8100), C(0x9100), C(0x88a8).,This parameter is not supported on Virtual Editions.,You should always wrap this value in quotes to prevent Ansible from interpreting the value as a literal hexadecimal number and converting it to an integer.

Returns:

  • (Object, nil) —

    Specifies the ether-type value used for the packets handled on this trunk when it is a member in a QinQ vlan.,The ether-type can be set to any string containing a valid hexadecimal 16 bits number, or any of the well known ether-types; C(0x8100), C(0x9100), C(0x88a8).,This parameter is not supported on Virtual Editions.,You should always wrap this value in quotes to prevent Ansible from interpreting the value as a literal hexadecimal number and converting it to an integer.



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

attribute :qinq_ethertype

#state ⇒ :present, ...

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

Returns:

  • (:present, :absent, nil) —

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



46
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_trunk.rb', line 46

attribute :state