Class: Ansible::Ruby::Modules::Ce_bgp_neighbor

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

Overview

Manages BGP peer configurations on HUAWEI CloudEngine switches.

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

#conn_retry_time ⇒ Object?

Returns ConnectRetry interval. The value is an integer ranging from 1 to 65535.

Returns:

  • (Object, nil) —

    ConnectRetry interval. The value is an integer ranging from 1 to 65535.



85
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 85

attribute :conn_retry_time

#connect_mode ⇒ Object?

Returns The value can be Connect-only, Listen-only, or Both.

Returns:

  • (Object, nil) —

    The value can be Connect-only, Listen-only, or Both.



59
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 59

attribute :connect_mode

#conventional ⇒ :no_use, ...

Returns If the value is true, the router has all extended capabilities. If the value is false, the router does not have all extended capabilities.

Returns:

  • (:no_use, :true, :false, nil) —

    If the value is true, the router has all extended capabilities. If the value is false, the router does not have all extended capabilities.



38
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 38

attribute :conventional

#description ⇒ Object?

Returns Description of a peer, which can be letters or digits. The value is a string of 1 to 80 characters.

Returns:

  • (Object, nil) —

    Description of a peer, which can be letters or digits. The value is a string of 1 to 80 characters.



28
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 28

attribute :description

#dual_as ⇒ :no_use, ...

Returns If the value is true, the EBGP peer can use either a fake AS number or the actual AS number. If the value is false, the EBGP peer can only use a fake AS number.

Returns:

  • (:no_use, :true, :false, nil) —

    If the value is true, the EBGP peer can use either a fake AS number or the actual AS number. If the value is false, the EBGP peer can only use a fake AS number.



34
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 34

attribute :dual_as

#ebgp_max_hop ⇒ Object?

Returns Maximum number of hops in an indirect EBGP connection. The value is an ranging from 1 to 255.

Returns:

  • (Object, nil) —

    Maximum number of hops in an indirect EBGP connection. The value is an ranging from 1 to 255.



53
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 53

attribute :ebgp_max_hop

#fake_as ⇒ Object?

Returns Fake AS number that is specified for a local peer. The value is a string of 1 to 11 characters.

Returns:

  • (Object, nil) —

    Fake AS number that is specified for a local peer. The value is a string of 1 to 11 characters.



31
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 31

attribute :fake_as

#hold_time ⇒ Object?

Returns Specify the Hold time of a peer or peer group. The value is 0 or an integer ranging from 3 to 65535.

Returns:

  • (Object, nil) —

    Specify the Hold time of a peer or peer group. The value is 0 or an integer ranging from 3 to 65535.



76
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 76

attribute :hold_time

#is_bfd_block ⇒ :no_use, ...

Returns If the value is true, peers are enabled to inherit the BFD function from the peer group. If the value is false, peers are disabled to inherit the BFD function from the peer group.

Returns:

  • (:no_use, :true, :false, nil) —

    If the value is true, peers are enabled to inherit the BFD function from the peer group. If the value is false, peers are disabled to inherit the BFD function from the peer group.



103
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 103

attribute :is_bfd_block

#is_bfd_enable ⇒ :no_use, ...

Returns If the value is true, BFD is enabled. If the value is false, BFD is disabled.

Returns:

  • (:no_use, :true, :false, nil) —

    If the value is true, BFD is enabled. If the value is false, BFD is disabled.



110
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 110

attribute :is_bfd_enable

#is_ignore ⇒ :no_use, ...

Returns If the value is true, the session with a specified peer is torn down and all related routing entries are cleared. If the value is false, the session with a specified peer is retained.

Returns:

  • (:no_use, :true, :false, nil) —

    If the value is true, the session with a specified peer is torn down and all related routing entries are cleared. If the value is false, the session with a specified peer is retained.



46
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 46

attribute :is_ignore

#is_log_change ⇒ :no_use, ...

Returns If the value is true, BGP is enabled to record peer session status and event information. If the value is false, BGP is disabled from recording peer session status and event information.

Returns:

  • (:no_use, :true, :false, nil) —

    If the value is true, BGP is enabled to record peer session status and event information. If the value is false, BGP is disabled from recording peer session status and event information.



62
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 62

attribute :is_log_change

#is_single_hop ⇒ :no_use, ...

Returns If the value is true, the system is enabled to preferentially use the single-hop mode for BFD session setup between IBGP peers. If the value is false, the system is disabled from preferentially using the single-hop mode for BFD session setup between IBGP peers.

Returns:

  • (:no_use, :true, :false, nil) —

    If the value is true, the system is enabled to preferentially use the single-hop mode for BFD session setup between IBGP peers. If the value is false, the system is disabled from preferentially using the single-hop mode for BFD session setup between IBGP peers.



120
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 120

attribute :is_single_hop

#keep_alive_time ⇒ Object?

Returns Specify the Keepalive time of a peer or peer group. The value is an integer ranging from 0 to 21845. The default value is 60.

Returns:

  • (Object, nil) —

    Specify the Keepalive time of a peer or peer group. The value is an integer ranging from 0 to 21845. The default value is 60.



73
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 73

attribute :keep_alive_time

#key_chain_name ⇒ Object?

Returns Specify the Keychain authentication name used when BGP peers establish a TCP connection. The value is a string of 1 to 47 case-insensitive characters.

Returns:

  • (Object, nil) —

    Specify the Keychain authentication name used when BGP peers establish a TCP connection. The value is a string of 1 to 47 case-insensitive characters.



82
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 82

attribute :key_chain_name

#local_if_name ⇒ Object?

Returns Name of a source interface that sends BGP packets. The value is a string of 1 to 63 characters.

Returns:

  • (Object, nil) —

    Name of a source interface that sends BGP packets. The value is a string of 1 to 63 characters.



50
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 50

attribute :local_if_name

#min_hold_time ⇒ Object?

Returns Specify the Min hold time of a peer or peer group.

Returns:

  • (Object, nil) —

    Specify the Min hold time of a peer or peer group.



79
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 79

attribute :min_hold_time

#mpls_local_ifnet_disable ⇒ :no_use, ...

Returns If the value is true, peer create MPLS Local IFNET disable. If the value is false, peer create MPLS Local IFNET enable.

Returns:

  • (:no_use, :true, :false, nil) —

    If the value is true, peer create MPLS Local IFNET disable. If the value is false, peer create MPLS Local IFNET enable.



91
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 91

attribute :mpls_local_ifnet_disable

#multiplier ⇒ Object?

Returns Specify the detection multiplier. The default value is 3. The value is an integer ranging from 3 to 50.

Returns:

  • (Object, nil) —

    Specify the detection multiplier. The default value is 3. The value is an integer ranging from 3 to 50.



107
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 107

attribute :multiplier

#peer_addr ⇒ Object

Returns Connection address of a peer, which can be an IPv4 or IPv6 address.

Returns:

  • (Object) —

    Connection address of a peer, which can be an IPv4 or IPv6 address.



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

attribute :peer_addr

#prepend_fake_as ⇒ :no_use, ...

Returns Add the Fake AS number to received Update packets.

Returns:

  • (:no_use, :true, :false, nil) —

    Add the Fake AS number to received Update packets.



99
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 99

attribute :prepend_fake_as

#prepend_global_as ⇒ :no_use, ...

Returns Add the global AS number to the Update packets to be advertised.

Returns:

  • (:no_use, :true, :false, nil) —

    Add the global AS number to the Update packets to be advertised.



95
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 95

attribute :prepend_global_as

#pswd_cipher_text ⇒ Object?

Returns The character string in a password identifies the contents of the password, spaces not supported. The value is a string of 1 to 255 characters.

Returns:

  • (Object, nil) —

    The character string in a password identifies the contents of the password, spaces not supported. The value is a string of 1 to 255 characters.



70
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 70

attribute :pswd_cipher_text

#pswd_type ⇒ :null, ...

Returns Enable BGP peers to establish a TCP connection and perform the Message Digest 5 (MD5) authentication for BGP messages.

Returns:

  • (:null, :cipher, :simple, nil) —

    Enable BGP peers to establish a TCP connection and perform the Message Digest 5 (MD5) authentication for BGP messages.



66
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 66

attribute :pswd_type

#remote_as ⇒ Object

Returns AS number of a peer. The value is a string of 1 to 11 characters.

Returns:

  • (Object) —

    AS number of a peer. The value is a string of 1 to 11 characters.



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

attribute :remote_as

#route_refresh ⇒ :no_use, ...

Returns If the value is true, BGP is enabled to advertise REFRESH packets. If the value is false, the route refresh function is enabled.

Returns:

  • (:no_use, :true, :false, nil) —

    If the value is true, BGP is enabled to advertise REFRESH packets. If the value is false, the route refresh function is enabled.



42
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 42

attribute :route_refresh

#rx_interval ⇒ Object?

Returns Specify the minimum interval at which BFD packets are received. The value is an integer ranging from 50 to 1000, in milliseconds.

Returns:

  • (Object, nil) —

    Specify the minimum interval at which BFD packets are received. The value is an integer ranging from 50 to 1000, in milliseconds.



114
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 114

attribute :rx_interval

#state ⇒ :present, ...

Returns Specify desired state of the resource.

Returns:

  • (:present, :absent, nil) —

    Specify desired state of the resource.



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

attribute :state

#tcp_MSS ⇒ Object?

Returns Maximum TCP MSS value used for TCP connection establishment for a peer. The value is an integer ranging from 176 to 4096.

Returns:

  • (Object, nil) —

    Maximum TCP MSS value used for TCP connection establishment for a peer. The value is an integer ranging from 176 to 4096.



88
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 88

attribute :tcp_MSS

#tx_interval ⇒ Object?

Returns Specify the minimum interval at which BFD packets are sent. The value is an integer ranging from 50 to 1000, in milliseconds.

Returns:

  • (Object, nil) —

    Specify the minimum interval at which BFD packets are sent. The value is an integer ranging from 50 to 1000, in milliseconds.



117
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 117

attribute :tx_interval

#valid_ttl_hops ⇒ Object?

Returns Enable GTSM on a peer or peer group. The valid-TTL-Value parameter is used to specify the number of TTL hops to be detected. The value is an integer ranging from 1 to 255.

Returns:

  • (Object, nil) —

    Enable GTSM on a peer or peer group. The valid-TTL-Value parameter is used to specify the number of TTL hops to be detected. The value is an integer ranging from 1 to 255.



56
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor.rb', line 56

attribute :valid_ttl_hops

#vrf_name ⇒ Object

Returns Name of a BGP instance. The name is a case-sensitive string of characters. The BGP instance can be used only after the corresponding VPN instance is created.

Returns:

  • (Object) —

    Name of a BGP instance. The name is a case-sensitive string of characters. The BGP instance can be used only after the corresponding VPN instance is created.



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

attribute :vrf_name