Class: Ansible::Ruby::Modules::Ce_bgp_neighbor_af
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Ce_bgp_neighbor_af
- Defined in:
- lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb
Overview
Manages BGP neighbor Address-family configurations on HUAWEI CloudEngine switches.
Instance Method Summary collapse
-
#add_path_mode ⇒ :null, ...
Null, Null.
-
#adv_add_path_num ⇒ Object?
The number of addPath advertise route.
-
#advertise_arp ⇒ :no_use, ...
If the value is true, advertised ARP routes are distinguished.
-
#advertise_community ⇒ :no_use, ...
If the value is true, the community attribute is advertised to peers.
-
#advertise_ext_community ⇒ :no_use, ...
If the value is true, the extended community attribute is advertised to peers.
-
#advertise_irb ⇒ :no_use, ...
If the value is true, advertised IRB routes are distinguished.
-
#advertise_remote_nexthop ⇒ :no_use, ...
If the value is true, the remote next-hop attribute is advertised to peers.
-
#af_type ⇒ :ipv4uni, ...
Address family type of a BGP instance.
-
#allow_as_loop_enable ⇒ :no_use, ...
If the value is true, repetitive local AS numbers are allowed.
-
#allow_as_loop_limit ⇒ Object?
Set the maximum number of repetitive local AS number.
-
#default_rt_adv_enable ⇒ :no_use, ...
If the value is true, the function to advertise default routes to peers is enabled.
-
#default_rt_adv_policy ⇒ Object?
Specify the name of a used policy.
-
#default_rt_match_mode ⇒ :null, ...
Null, Null.
-
#discard_ext_community ⇒ :no_use, ...
If the value is true, the extended community attribute in the peer route information is discarded.
-
#export_acl_name_or_num ⇒ Object?
Apply an IPv4 ACL-based filtering policy to the routes to be advertised to a specified peer.
-
#export_as_path_filter ⇒ Object?
Apply an AS_Path-based filtering policy to the routes to be advertised to a specified peer.
-
#export_as_path_name_or_num ⇒ Object?
Application of a AS path list based filtering policy to the routing of a specified peer.
-
#export_pref_filt_name ⇒ Object?
Specify the IPv4 filtering policy applied to the routes to be advertised to a specified peer.
-
#export_rt_policy_name ⇒ Object?
Specify the filtering policy applied to the routes to be advertised to a peer.
-
#import_acl_name_or_num ⇒ Object?
Apply an IPv4 ACL-based filtering policy to the routes received from a specified peer.
-
#import_as_path_filter ⇒ Object?
Apply an AS_Path-based filtering policy to the routes received from a specified peer.
-
#import_as_path_name_or_num ⇒ Object?
A routing strategy based on the AS path list for routing received by a designated peer.
-
#import_pref_filt_name ⇒ Object?
Specify the IPv4 filtering policy applied to the routes received from a specified peer.
-
#import_rt_policy_name ⇒ Object?
Specify the filtering policy applied to the routes learned from a peer.
-
#ipprefix_orf_enable ⇒ :no_use, ...
If the value is true, the address prefix-based Outbound Route Filter (ORF) capability is enabled for peers.
-
#is_nonstd_ipprefix_mod ⇒ :no_use, ...
If the value is true, Non-standard capability codes are used during capability negotiation.
-
#keep_all_routes ⇒ :no_use, ...
If the value is true, the system stores all route update messages received from all peers (groups) after BGP connection setup.
-
#nexthop_configure ⇒ :null, ...
Null, The next hop is not changed.
-
#orf_mode ⇒ :null, ...
ORF mode.
-
#orftype ⇒ Object?
ORF Type.
-
#origin_as_valid ⇒ :no_use, ...
If the value is true, Application results of route announcement.
-
#preferred_value ⇒ Object?
Assign a preferred value for the routes learned from a specified peer.
-
#public_as_only ⇒ :no_use, ...
If the value is true, sent BGP update messages carry only the public AS number but do not carry private AS numbers.
-
#public_as_only_force ⇒ :no_use, ...
If the value is true, sent BGP update messages carry only the public AS number but do not carry private AS numbers.
-
#public_as_only_limited ⇒ :no_use, ...
Limited use public as number.
-
#public_as_only_replace ⇒ :no_use, ...
Private as replaced by public as number.
-
#public_as_only_skip_peer_as ⇒ :no_use, ...
Public as only skip peer as.
-
#redirect_ip ⇒ :no_use, ...
Redirect ip.
-
#redirect_ip_vaildation ⇒ :no_use, ...
Redirect ip vaildation.
-
#reflect_client ⇒ :no_use, ...
If the value is true, the local device functions as the route reflector and a peer functions as a client of the route reflector.
-
#remote_address ⇒ Object
IPv4 or IPv6 peer connection address.
-
#route_limit ⇒ Object?
Configure the maximum number of routes that can be accepted from a peer.
-
#route_limit_idle_timeout ⇒ Object?
Specify the value of the idle-timeout timer to automatically reestablish the connections after they are cut off when the number of routes exceeds the set threshold.
-
#route_limit_percent ⇒ Object?
Specify the percentage of routes when a router starts to generate an alarm.
-
#route_limit_type ⇒ :noparameter, ...
Noparameter, After the number of received routes exceeds the threshold and the timeout timer expires,no action.
-
#rt_updt_interval ⇒ Object?
Specify the minimum interval at which Update packets are sent.
-
#soostring ⇒ Object?
Configure the Site-of-Origin (SoO) extended community attribute.
-
#substitute_as_enable ⇒ :no_use, ...
If the value is true, the function to replace a specified peer’s AS number in the AS-Path attribute with the local AS number is enabled.
-
#update_pkt_standard_compatible ⇒ :no_use, ...
If the value is true, When the vpnv4 multicast neighbor receives and updates the message, the message has no label.
-
#vpls_ad_disable ⇒ :no_use, ...
If the value is true, enable vpls-ad.
-
#vpls_enable ⇒ :no_use, ...
If the value is true, vpls enable.
-
#vrf_name ⇒ Object
Name of a BGP instance.
Methods inherited from Base
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
#add_path_mode ⇒ :null, ...
Returns null, Null. receive, Support receiving Add-Path routes. send, Support sending Add-Path routes. both, Support receiving and sending Add-Path routes.
177 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 177 attribute :add_path_mode |
#adv_add_path_num ⇒ Object?
Returns The number of addPath advertise route. The value is an integer ranging from 2 to 64.
181 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 181 attribute :adv_add_path_num |
#advertise_arp ⇒ :no_use, ...
Returns If the value is true, advertised ARP routes are distinguished. If the value is false, advertised ARP routes are not distinguished.
28 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 28 attribute :advertise_arp |
#advertise_community ⇒ :no_use, ...
Returns If the value is true, the community attribute is advertised to peers. If the value is false, the community attribute is not advertised to peers.
36 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 36 attribute :advertise_community |
#advertise_ext_community ⇒ :no_use, ...
Returns If the value is true, the extended community attribute is advertised to peers. If the value is false, the extended community attribute is not advertised to peers.
40 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 40 attribute :advertise_ext_community |
#advertise_irb ⇒ :no_use, ...
Returns If the value is true, advertised IRB routes are distinguished. If the value is false, advertised IRB routes are not distinguished.
24 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 24 attribute :advertise_irb |
#advertise_remote_nexthop ⇒ :no_use, ...
Returns If the value is true, the remote next-hop attribute is advertised to peers. If the value is false, the remote next-hop attribute is not advertised to any peers.
32 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 32 attribute :advertise_remote_nexthop |
#af_type ⇒ :ipv4uni, ...
Returns Address family type of a BGP instance.
16 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 16 attribute :af_type |
#allow_as_loop_enable ⇒ :no_use, ...
Returns If the value is true, repetitive local AS numbers are allowed. If the value is false, repetitive local AS numbers are not allowed.
48 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 48 attribute :allow_as_loop_enable |
#allow_as_loop_limit ⇒ Object?
Returns Set the maximum number of repetitive local AS number. The value is an integer ranging from 1 to 10.
52 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 52 attribute :allow_as_loop_limit |
#default_rt_adv_enable ⇒ :no_use, ...
Returns If the value is true, the function to advertise default routes to peers is enabled. If the value is false, the function to advertise default routes to peers is disabled.
166 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 166 attribute :default_rt_adv_enable |
#default_rt_adv_policy ⇒ Object?
Returns Specify the name of a used policy. The value is a string. The value is a string of 1 to 40 characters.
170 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 170 attribute :default_rt_adv_policy |
#default_rt_match_mode ⇒ :null, ...
Returns null, Null. matchall, Advertise the default route if all matching conditions are met. matchany, Advertise the default route if any matching condition is met.
173 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 173 attribute :default_rt_match_mode |
#discard_ext_community ⇒ :no_use, ...
Returns If the value is true, the extended community attribute in the peer route information is discarded. If the value is false, the extended community attribute in the peer route information is not discarded.
44 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 44 attribute :discard_ext_community |
#export_acl_name_or_num ⇒ Object?
Returns Apply an IPv4 ACL-based filtering policy to the routes to be advertised to a specified peer. The value is a string of 1 to 32 characters.
145 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 145 attribute :export_acl_name_or_num |
#export_as_path_filter ⇒ Object?
Returns Apply an AS_Path-based filtering policy to the routes to be advertised to a specified peer. The value is an integer ranging from 1 to 256.
133 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 133 attribute :export_as_path_filter |
#export_as_path_name_or_num ⇒ Object?
Returns Application of a AS path list based filtering policy to the routing of a specified peer.
139 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 139 attribute :export_as_path_name_or_num |
#export_pref_filt_name ⇒ Object?
Returns Specify the IPv4 filtering policy applied to the routes to be advertised to a specified peer. The value is a string of 1 to 169 characters.
127 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 127 attribute :export_pref_filt_name |
#export_rt_policy_name ⇒ Object?
Returns Specify the filtering policy applied to the routes to be advertised to a peer. The value is a string of 1 to 40 characters.
121 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 121 attribute :export_rt_policy_name |
#import_acl_name_or_num ⇒ Object?
Returns Apply an IPv4 ACL-based filtering policy to the routes received from a specified peer. The value is a string of 1 to 32 characters.
142 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 142 attribute :import_acl_name_or_num |
#import_as_path_filter ⇒ Object?
Returns Apply an AS_Path-based filtering policy to the routes received from a specified peer. The value is an integer ranging from 1 to 256.
130 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 130 attribute :import_as_path_filter |
#import_as_path_name_or_num ⇒ Object?
Returns A routing strategy based on the AS path list for routing received by a designated peer.
136 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 136 attribute :import_as_path_name_or_num |
#import_pref_filt_name ⇒ Object?
Returns Specify the IPv4 filtering policy applied to the routes received from a specified peer. The value is a string of 1 to 169 characters.
124 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 124 attribute :import_pref_filt_name |
#import_rt_policy_name ⇒ Object?
Returns Specify the filtering policy applied to the routes learned from a peer. The value is a string of 1 to 40 characters.
118 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 118 attribute :import_rt_policy_name |
#ipprefix_orf_enable ⇒ :no_use, ...
Returns If the value is true, the address prefix-based Outbound Route Filter (ORF) capability is enabled for peers. If the value is false, the address prefix-based Outbound Route Filter (ORF) capability is disabled for peers.
148 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 148 attribute :ipprefix_orf_enable |
#is_nonstd_ipprefix_mod ⇒ :no_use, ...
Returns If the value is true, Non-standard capability codes are used during capability negotiation. If the value is false, RFC-defined standard ORF capability codes are used during capability negotiation.
152 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 152 attribute :is_nonstd_ipprefix_mod |
#keep_all_routes ⇒ :no_use, ...
Returns If the value is true, the system stores all route update messages received from all peers (groups) after BGP connection setup. If the value is false, the system stores only BGP update messages that are received from peers and pass the configured import policy.
55 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 55 attribute :keep_all_routes |
#nexthop_configure ⇒ :null, ...
Returns null, The next hop is not changed. local, The next hop is changed to the local IP address. invariable, Prevent the device from changing the next hop of each imported IGP route when advertising it to its BGP peers.
59 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 59 attribute :nexthop_configure |
#orf_mode ⇒ :null, ...
Returns ORF mode. null, Default value. receive, ORF for incoming packets. send, ORF for outgoing packets. both, ORF for incoming and outgoing packets.
159 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 159 attribute :orf_mode |
#orftype ⇒ Object?
Returns ORF Type. The value is an integer ranging from 0 to 65535.
156 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 156 attribute :orftype |
#origin_as_valid ⇒ :no_use, ...
Returns If the value is true, Application results of route announcement. If the value is false, Routing application results are not notified.
184 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 184 attribute :origin_as_valid |
#preferred_value ⇒ Object?
Returns Assign a preferred value for the routes learned from a specified peer. The value is an integer ranging from 0 to 65535.
63 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 63 attribute :preferred_value |
#public_as_only ⇒ :no_use, ...
Returns If the value is true, sent BGP update messages carry only the public AS number but do not carry private AS numbers. If the value is false, sent BGP update messages can carry private AS numbers.
66 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 66 attribute :public_as_only |
#public_as_only_force ⇒ :no_use, ...
Returns If the value is true, sent BGP update messages carry only the public AS number but do not carry private AS numbers. If the value is false, sent BGP update messages can carry private AS numbers.
70 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 70 attribute :public_as_only_force |
#public_as_only_limited ⇒ :no_use, ...
Returns Limited use public as number.
74 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 74 attribute :public_as_only_limited |
#public_as_only_replace ⇒ :no_use, ...
Returns Private as replaced by public as number.
78 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 78 attribute :public_as_only_replace |
#public_as_only_skip_peer_as ⇒ :no_use, ...
Returns Public as only skip peer as.
82 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 82 attribute :public_as_only_skip_peer_as |
#redirect_ip ⇒ :no_use, ...
Returns Redirect ip.
102 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 102 attribute :redirect_ip |
#redirect_ip_vaildation ⇒ :no_use, ...
Returns Redirect ip vaildation.
106 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 106 attribute :redirect_ip_vaildation |
#reflect_client ⇒ :no_use, ...
Returns If the value is true, the local device functions as the route reflector and a peer functions as a client of the route reflector. If the value is false, the route reflector and client functions are not configured.
110 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 110 attribute :reflect_client |
#remote_address ⇒ Object
Returns IPv4 or IPv6 peer connection address.
20 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 20 attribute :remote_address |
#route_limit ⇒ Object?
Returns Configure the maximum number of routes that can be accepted from a peer. The value is an integer ranging from 1 to 4294967295.
86 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 86 attribute :route_limit |
#route_limit_idle_timeout ⇒ Object?
Returns Specify the value of the idle-timeout timer to automatically reestablish the connections after they are cut off when the number of routes exceeds the set threshold. The value is an integer ranging from 1 to 1200.
96 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 96 attribute :route_limit_idle_timeout |
#route_limit_percent ⇒ Object?
Returns Specify the percentage of routes when a router starts to generate an alarm. The value is an integer ranging from 1 to 100.
89 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 89 attribute :route_limit_percent |
#route_limit_type ⇒ :noparameter, ...
Returns Noparameter, After the number of received routes exceeds the threshold and the timeout timer expires,no action. AlertOnly, An alarm is generated and no additional routes will be accepted if the maximum number of routes allowed have been received. IdleForever, The connection that is interrupted is not automatically re-established if the maximum number of routes allowed have been received. IdleTimeout, After the number of received routes exceeds the threshold and the timeout timer expires, the connection that is interrupted is automatically re-established.
92 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 92 attribute :route_limit_type |
#rt_updt_interval ⇒ Object?
Returns Specify the minimum interval at which Update packets are sent. The value is an integer, in seconds. The value is an integer ranging from 0 to 600.
99 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 99 attribute :rt_updt_interval |
#soostring ⇒ Object?
Returns Configure the Site-of-Origin (SoO) extended community attribute. The value is a string of 3 to 21 characters.
163 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 163 attribute :soostring |
#substitute_as_enable ⇒ :no_use, ...
Returns If the value is true, the function to replace a specified peer’s AS number in the AS-Path attribute with the local AS number is enabled. If the value is false, the function to replace a specified peer’s AS number in the AS-Path attribute with the local AS number is disabled.
114 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 114 attribute :substitute_as_enable |
#update_pkt_standard_compatible ⇒ :no_use, ...
Returns If the value is true, When the vpnv4 multicast neighbor receives and updates the message, the message has no label. If the value is false, When the vpnv4 multicast neighbor receives and updates the message, the message has label.
196 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 196 attribute :update_pkt_standard_compatible |
#vpls_ad_disable ⇒ :no_use, ...
Returns If the value is true, enable vpls-ad. If the value is false, disable vpls-ad.
192 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 192 attribute :vpls_ad_disable |
#vpls_enable ⇒ :no_use, ...
Returns If the value is true, vpls enable. If the value is false, vpls disable.
188 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 188 attribute :vpls_enable |
#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.
12 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_neighbor_af.rb', line 12 attribute :vrf_name |