Class: Ansible::Ruby::Modules::Ce_bfd_session

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

Overview

Manages BFD session configuration, creates a BFD session or deletes a specified BFD session on HUAWEI CloudEngine devices.

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

#addr_type ⇒ :ipv4?

Returns Specifies the peer IP address type.

Returns:

  • (:ipv4, nil) —

    Specifies the peer IP address type.



20
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bfd_session.rb', line 20

attribute :addr_type

#create_type ⇒ :static, ...

Returns BFD session creation mode, the currently created BFD session only supports static or static auto-negotiation mode.

Returns:

  • (:static, :auto, nil) —

    BFD session creation mode, the currently created BFD session only supports static or static auto-negotiation mode.



16
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bfd_session.rb', line 16

attribute :create_type

#dest_addr ⇒ Object?

Returns Specifies the peer IP address bound to the BFD session.

Returns:

  • (Object, nil) —

    Specifies the peer IP address bound to the BFD session.



27
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bfd_session.rb', line 27

attribute :dest_addr

#out_if_name ⇒ Object?

Returns Specifies the type and number of the interface bound to the BFD session.

Returns:

  • (Object, nil) —

    Specifies the type and number of the interface bound to the BFD session.



24
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bfd_session.rb', line 24

attribute :out_if_name

#session_name ⇒ Object

Returns Specifies the name of a BFD session. The value is a string of 1 to 15 case-sensitive characters without spaces.

Returns:

  • (Object) —

    Specifies the name of a BFD session. The value is a string of 1 to 15 case-sensitive characters without spaces.



12
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bfd_session.rb', line 12

attribute :session_name

#src_addr ⇒ Object?

Returns Indicates the source IP address carried in BFD packets.

Returns:

  • (Object, nil) —

    Indicates the source IP address carried in BFD packets.



30
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bfd_session.rb', line 30

attribute :src_addr

#state ⇒ :present, ...

Returns Determines whether the config should be present or not on the device.

Returns:

  • (:present, :absent, nil) —

    Determines whether the config should be present or not on the device.



40
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bfd_session.rb', line 40

attribute :state

#use_default_ip ⇒ :yes, ...

Returns Indicates the default multicast IP address that is bound to a BFD session. By default, BFD uses the multicast IP address 224.0.0.184. You can set the multicast IP address by running the default-ip-address command. The value is a bool type.

Returns:

  • (:yes, :no, nil) —

    Indicates the default multicast IP address that is bound to a BFD session. By default, BFD uses the multicast IP address 224.0.0.184. You can set the multicast IP address by running the default-ip-address command. The value is a bool type.



36
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bfd_session.rb', line 36

attribute :use_default_ip

#vrf_name ⇒ Object?

Returns Specifies the name of a Virtual Private Network (VPN) instance that is bound to a BFD session. The value is a string of 1 to 31 case-sensitive characters, spaces not supported. When double quotation marks are used around the string, spaces are allowed in the string. The value public is reserved and cannot be used as the VPN instance name.

Returns:

  • (Object, nil) —

    Specifies the name of a Virtual Private Network (VPN) instance that is bound to a BFD session. The value is a string of 1 to 31 case-sensitive characters, spaces not supported. When double quotation marks are used around the string, spaces are allowed in the string. The value public is reserved and cannot be used as the VPN instance name.



33
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bfd_session.rb', line 33

attribute :vrf_name