Class: Ansible::Ruby::Modules::Ce_bgp_af
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Ce_bgp_af
- Defined in:
- lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb
Overview
Manages BGP Address-family configurations on HUAWEI CloudEngine switches.
Instance Method Summary collapse
-
#active_route_advertise ⇒ :no_use, ...
If the value is true, BGP is enabled to advertise only optimal routes in the RM to peers.
-
#add_path_sel_num ⇒ Object?
Number of Add-Path routes.
-
#af_type ⇒ :ipv4uni, ...
Address family type of a BGP instance.
-
#allow_invalid_as ⇒ :no_use, ...
Allow routes with BGP origin AS validation result Invalid to be selected.
-
#always_compare_med ⇒ :no_use, ...
If the value is true, the MEDs of routes learned from peers in different autonomous systems are compared when BGP selects an optimal route.
-
#as_path_neglect ⇒ :no_use, ...
If the value is true, the AS path attribute is ignored when BGP selects an optimal route.
-
#auto_frr_enable ⇒ :no_use, ...
If the value is true, BGP auto FRR is enabled.
-
#default_local_pref ⇒ Object?
Set the Local-Preference attribute.
-
#default_med ⇒ Object?
Specify the Multi-Exit-Discriminator (MED) of BGP routes.
-
#default_rt_import_enable ⇒ :no_use, ...
If the value is true, importing default routes to the BGP routing table is allowed.
-
#determin_med ⇒ :no_use, ...
If the value is true, BGP deterministic-MED is enabled.
-
#ebgp_ecmp_nexthop_changed ⇒ :no_use, ...
If the value is true, the next hop of an advertised route is changed to the advertiser itself in EBGP load-balancing scenarios.
-
#ebgp_if_sensitive ⇒ :no_use, ...
If the value is true, after the fast EBGP interface awareness function is enabled, EBGP sessions on an interface are deleted immediately when the interface goes Down.
-
#ecmp_nexthop_changed ⇒ :no_use, ...
If the value is true, the next hop of an advertised route is changed to the advertiser itself in BGP load-balancing scenarios.
-
#ibgp_ecmp_nexthop_changed ⇒ :no_use, ...
If the value is true, the next hop of an advertised route is changed to the advertiser itself in IBGP load-balancing scenarios.
-
#igp_metric_ignore ⇒ :no_use, ...
If the value is true, the metrics of next-hop IGP routes are not compared when BGP selects an optimal route.
-
#import_process_id ⇒ Object?
Process ID of an imported routing protocol.
-
#import_protocol ⇒ :direct, ...
Routing protocol from which routes can be imported.
-
#ingress_lsp_policy_name ⇒ Object?
Ingress lsp policy name.
-
#load_balancing_as_path_ignore ⇒ :no_use, ...
Load balancing as path ignore.
-
#lowest_priority ⇒ :no_use, ...
If the value is true, enable reduce priority to advertise route.
-
#mask_len ⇒ Object?
Specify the mask length of an IP address.
-
#max_load_ebgp_num ⇒ Object?
Specify the maximum number of equal-cost EBGP routes.
-
#max_load_ibgp_num ⇒ Object?
Specify the maximum number of equal-cost IBGP routes.
-
#maximum_load_balance ⇒ Object?
Specify the maximum number of equal-cost routes in the BGP routing table.
-
#med_none_as_maximum ⇒ :no_use, ...
If the value is true, when BGP selects an optimal route, the system uses 4294967295 as the MED value of a route if the route’s attribute does not carry a MED value.
-
#network_address ⇒ Object?
Specify the IP address advertised by BGP.
-
#next_hop_sel_depend_type ⇒ :default, ...
Next hop select depend type.
-
#nexthop_third_party ⇒ :no_use, ...
If the value is true, the third-party next hop function is enabled.
-
#nhp_relay_route_policy_name ⇒ Object?
Specify the name of a route-policy for route iteration.
-
#originator_prior ⇒ :no_use, ...
Originator prior.
-
#policy_ext_comm_enable ⇒ :no_use, ...
If the value is true, modifying extended community attributes is allowed.
-
#policy_vpn_target ⇒ :no_use, ...
If the value is true, VPN-Target filtering function is performed for received VPN routes.
-
#preference_external ⇒ Object?
Set the protocol priority of EBGP routes.
-
#preference_internal ⇒ Object?
Set the protocol priority of IBGP routes.
-
#preference_local ⇒ Object?
Set the protocol priority of a local BGP route.
-
#prefrence_policy_name ⇒ Object?
Set a routing policy to filter routes so that a configured priority is applied to the routes that match the specified policy.
-
#reflect_between_client ⇒ :no_use, ...
If the value is true, route reflection is enabled between clients.
-
#reflect_chg_path ⇒ :no_use, ...
If the value is true, the route reflector is enabled to modify route path attributes based on an export policy.
-
#reflector_cluster_id ⇒ Object?
Set a cluster ID.
-
#reflector_cluster_ipv4 ⇒ Object?
Set a cluster ipv4 address.
-
#relay_delay_enable ⇒ :no_use, ...
If the value is true, relay delay enable.
-
#rib_only_enable ⇒ :no_use, ...
If the value is true, BGP routes cannot be advertised to the IP routing table.
-
#rib_only_policy_name ⇒ Object?
Specify the name of a routing policy.
-
#route_sel_delay ⇒ Object?
Route selection delay.
-
#router_id ⇒ Object?
ID of a router that is in IPv4 address format.
-
#router_id_neglect ⇒ :no_use, ...
If the value is true, the router ID attribute is ignored when BGP selects the optimal route.
-
#rr_filter_number ⇒ Object?
Set the number of the extended community filter supported by an RR group.
-
#state ⇒ :present, ...
Specify desired state of the resource.
-
#summary_automatic ⇒ :no_use, ...
If the value is true, automatic aggregation is enabled for locally imported routes.
-
#supernet_label_adv ⇒ :no_use, ...
If the value is true, the function to advertise supernetwork label is enabled.
-
#supernet_uni_adv ⇒ :no_use, ...
If the value is true, the function to advertise supernetwork unicast routes is enabled.
-
#vrf_name ⇒ Object
Name of a BGP instance.
-
#vrf_rid_auto_sel ⇒ :no_use, ...
If the value is true, VPN BGP instances are enabled to automatically select router IDs.
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
#active_route_advertise ⇒ :no_use, ...
Returns If the value is true, BGP is enabled to advertise only optimal routes in the RM to peers. If the value is false, BGP is not enabled to advertise only optimal routes in the RM to peers.
85 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 85 attribute :active_route_advertise |
#add_path_sel_num ⇒ Object?
Returns Number of Add-Path routes. The value is an integer ranging from 2 to 64.
157 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 157 attribute :add_path_sel_num |
#af_type ⇒ :ipv4uni, ...
Returns Address family type of a BGP instance.
20 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 20 attribute :af_type |
#allow_invalid_as ⇒ :no_use, ...
Returns Allow routes with BGP origin AS validation result Invalid to be selected. If the value is true, invalid routes can participate in route selection. If the value is false, invalid routes cannot participate in route selection.
163 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 163 attribute :allow_invalid_as |
#always_compare_med ⇒ :no_use, ...
Returns If the value is true, the MEDs of routes learned from peers in different autonomous systems are compared when BGP selects an optimal route. If the value is false, the MEDs of routes learned from peers in different autonomous systems are not compared when BGP selects an optimal route.
105 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 105 attribute :always_compare_med |
#as_path_neglect ⇒ :no_use, ...
Returns If the value is true, the AS path attribute is ignored when BGP selects an optimal route. If the value is false, the AS path attribute is not ignored when BGP selects an optimal route. An AS path with a smaller length has a higher priority.
89 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 89 attribute :as_path_neglect |
#auto_frr_enable ⇒ :no_use, ...
Returns If the value is true, BGP auto FRR is enabled. If the value is false, BGP auto FRR is disabled.
70 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 70 attribute :auto_frr_enable |
#default_local_pref ⇒ Object?
Returns Set the Local-Preference attribute. The value is an integer. The value is an integer ranging from 0 to 4294967295.
45 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 45 attribute :default_local_pref |
#default_med ⇒ Object?
Returns Specify the Multi-Exit-Discriminator (MED) of BGP routes. The value is an integer ranging from 0 to 4294967295.
48 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 48 attribute :default_med |
#default_rt_import_enable ⇒ :no_use, ...
Returns If the value is true, importing default routes to the BGP routing table is allowed. If the value is false, importing default routes to the BGP routing table is not allowed.
51 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 51 attribute :default_rt_import_enable |
#determin_med ⇒ :no_use, ...
Returns If the value is true, BGP deterministic-MED is enabled. If the value is false, BGP deterministic-MED is disabled.
109 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 109 attribute :determin_med |
#ebgp_ecmp_nexthop_changed ⇒ :no_use, ...
Returns If the value is true, the next hop of an advertised route is changed to the advertiser itself in EBGP load-balancing scenarios. If the value is false, the next hop of an advertised route is not changed to the advertiser itself in EBGP load-balancing scenarios.
34 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 34 attribute :ebgp_ecmp_nexthop_changed |
#ebgp_if_sensitive ⇒ :no_use, ...
Returns If the value is true, after the fast EBGP interface awareness function is enabled, EBGP sessions on an interface are deleted immediately when the interface goes Down. If the value is false, after the fast EBGP interface awareness function is enabled, EBGP sessions on an interface are not deleted immediately when the interface goes Down.
149 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 149 attribute :ebgp_if_sensitive |
#ecmp_nexthop_changed ⇒ :no_use, ...
Returns If the value is true, the next hop of an advertised route is changed to the advertiser itself in BGP load-balancing scenarios. If the value is false, the next hop of an advertised route is not changed to the advertiser itself in BGP load-balancing scenarios.
41 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 41 attribute :ecmp_nexthop_changed |
#ibgp_ecmp_nexthop_changed ⇒ :no_use, ...
Returns If the value is true, the next hop of an advertised route is changed to the advertiser itself in IBGP load-balancing scenarios. If the value is false, the next hop of an advertised route is not changed to the advertiser itself in IBGP load-balancing scenarios.
27 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 27 attribute :ibgp_ecmp_nexthop_changed |
#igp_metric_ignore ⇒ :no_use, ...
Returns If the value is true, the metrics of next-hop IGP routes are not compared when BGP selects an optimal route. If the value is false, the metrics of next-hop IGP routes are not compared when BGP selects an optimal route. A route with a smaller metric has a higher priority.
101 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 101 attribute :igp_metric_ignore |
#import_process_id ⇒ Object?
Returns Process ID of an imported routing protocol. The value is an integer ranging from 0 to 4294967295.
198 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 198 attribute :import_process_id |
#import_protocol ⇒ :direct, ...
Returns Routing protocol from which routes can be imported.
194 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 194 attribute :import_protocol |
#ingress_lsp_policy_name ⇒ Object?
Returns Ingress lsp policy name.
179 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 179 attribute :ingress_lsp_policy_name |
#load_balancing_as_path_ignore ⇒ :no_use, ...
Returns Load balancing as path ignore.
74 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 74 attribute :load_balancing_as_path_ignore |
#lowest_priority ⇒ :no_use, ...
Returns If the value is true, enable reduce priority to advertise route. If the value is false, disable reduce priority to advertise route.
186 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 186 attribute :lowest_priority |
#mask_len ⇒ Object?
Returns Specify the mask length of an IP address. The value is an integer ranging from 0 to 128.
204 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 204 attribute :mask_len |
#max_load_ebgp_num ⇒ Object?
Returns Specify the maximum number of equal-cost EBGP routes. The value is an integer ranging from 1 to 65535.
31 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 31 attribute :max_load_ebgp_num |
#max_load_ibgp_num ⇒ Object?
Returns Specify the maximum number of equal-cost IBGP routes. The value is an integer ranging from 1 to 65535.
24 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 24 attribute :max_load_ibgp_num |
#maximum_load_balance ⇒ Object?
Returns Specify the maximum number of equal-cost routes in the BGP routing table. The value is an integer ranging from 1 to 65535.
38 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 38 attribute :maximum_load_balance |
#med_none_as_maximum ⇒ :no_use, ...
Returns If the value is true, when BGP selects an optimal route, the system uses 4294967295 as the MED value of a route if the route’s attribute does not carry a MED value. If the value is false, the system uses 0 as the MED value of a route if the route’s attribute does not carry a MED value.
93 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 93 attribute :med_none_as_maximum |
#network_address ⇒ Object?
Returns Specify the IP address advertised by BGP. The value is a string of 0 to 255 characters.
201 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 201 attribute :network_address |
#next_hop_sel_depend_type ⇒ :default, ...
Returns Next hop select depend type.
142 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 142 attribute :next_hop_sel_depend_type |
#nexthop_third_party ⇒ :no_use, ...
Returns If the value is true, the third-party next hop function is enabled. If the value is false, the third-party next hop function is disabled.
62 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 62 attribute :nexthop_third_party |
#nhp_relay_route_policy_name ⇒ Object?
Returns Specify the name of a route-policy for route iteration. The value is a string of 1 to 40 characters.
146 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 146 attribute :nhp_relay_route_policy_name |
#originator_prior ⇒ :no_use, ...
Returns Originator prior.
182 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 182 attribute :originator_prior |
#policy_ext_comm_enable ⇒ :no_use, ...
Returns If the value is true, modifying extended community attributes is allowed. If the value is false, modifying extended community attributes is not allowed.
167 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 167 attribute :policy_ext_comm_enable |
#policy_vpn_target ⇒ :no_use, ...
Returns If the value is true, VPN-Target filtering function is performed for received VPN routes. If the value is false, VPN-Target filtering function is not performed for received VPN routes.
138 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 138 attribute :policy_vpn_target |
#preference_external ⇒ Object?
Returns Set the protocol priority of EBGP routes. The value is an integer ranging from 1 to 255.
113 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 113 attribute :preference_external |
#preference_internal ⇒ Object?
Returns Set the protocol priority of IBGP routes. The value is an integer ranging from 1 to 255.
116 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 116 attribute :preference_internal |
#preference_local ⇒ Object?
Returns Set the protocol priority of a local BGP route. The value is an integer ranging from 1 to 255.
119 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 119 attribute :preference_local |
#prefrence_policy_name ⇒ Object?
Returns Set a routing policy to filter routes so that a configured priority is applied to the routes that match the specified policy. The value is a string of 1 to 40 characters.
122 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 122 attribute :prefrence_policy_name |
#reflect_between_client ⇒ :no_use, ...
Returns If the value is true, route reflection is enabled between clients. If the value is false, route reflection is disabled between clients.
125 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 125 attribute :reflect_between_client |
#reflect_chg_path ⇒ :no_use, ...
Returns If the value is true, the route reflector is enabled to modify route path attributes based on an export policy. If the value is false, the route reflector is disabled from modifying route path attributes based on an export policy.
153 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 153 attribute :reflect_chg_path |
#reflector_cluster_id ⇒ Object?
Returns Set a cluster ID. Configuring multiple RRs in a cluster can enhance the stability of the network. The value is an integer ranging from 1 to 4294967295.
129 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 129 attribute :reflector_cluster_id |
#reflector_cluster_ipv4 ⇒ Object?
Returns Set a cluster ipv4 address. The value is expressed in the format of an IPv4 address.
132 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 132 attribute :reflector_cluster_ipv4 |
#relay_delay_enable ⇒ :no_use, ...
Returns If the value is true, relay delay enable. If the value is false, relay delay disable.
190 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 190 attribute :relay_delay_enable |
#rib_only_enable ⇒ :no_use, ...
Returns If the value is true, BGP routes cannot be advertised to the IP routing table. If the value is false, Routes preferred by BGP are advertised to the IP routing table.
78 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 78 attribute :rib_only_enable |
#rib_only_policy_name ⇒ Object?
Returns Specify the name of a routing policy. The value is a string of 1 to 40 characters.
82 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 82 attribute :rib_only_policy_name |
#route_sel_delay ⇒ Object?
Returns Route selection delay. The value is an integer ranging from 0 to 3600.
160 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 160 attribute :route_sel_delay |
#router_id ⇒ Object?
Returns ID of a router that is in IPv4 address format. The value is a string of 0 to 255 characters. The value is in dotted decimal notation.
55 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 55 attribute :router_id |
#router_id_neglect ⇒ :no_use, ...
Returns If the value is true, the router ID attribute is ignored when BGP selects the optimal route. If the value is false, the router ID attribute is not ignored when BGP selects the optimal route.
97 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 97 attribute :router_id_neglect |
#rr_filter_number ⇒ Object?
Returns Set the number of the extended community filter supported by an RR group. The value is a string of 1 to 51 characters.
135 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 135 attribute :rr_filter_number |
#state ⇒ :present, ...
Returns Specify desired state of the resource.
12 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 12 attribute :state |
#summary_automatic ⇒ :no_use, ...
Returns If the value is true, automatic aggregation is enabled for locally imported routes. If the value is false, automatic aggregation is disabled for locally imported routes.
66 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 66 attribute :summary_automatic |
#supernet_label_adv ⇒ :no_use, ...
Returns If the value is true, the function to advertise supernetwork label is enabled. If the value is false, the function to advertise supernetwork label is disabled.
175 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 175 attribute :supernet_label_adv |
#supernet_uni_adv ⇒ :no_use, ...
Returns If the value is true, the function to advertise supernetwork unicast routes is enabled. If the value is false, the function to advertise supernetwork unicast routes is disabled.
171 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 171 attribute :supernet_uni_adv |
#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. The value is a string of 1 to 31 case-sensitive characters.
16 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 16 attribute :vrf_name |
#vrf_rid_auto_sel ⇒ :no_use, ...
Returns If the value is true, VPN BGP instances are enabled to automatically select router IDs. If the value is false, VPN BGP instances are disabled from automatically selecting router IDs.
58 |
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_bgp_af.rb', line 58 attribute :vrf_rid_auto_sel |