Class: Ansible::Ruby::Modules::Nxos_bgp

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Nxos_bgp

Defined in:

lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb

Overview

Manages BGP configurations on NX-OS switches.

Instance Method Summary

• #asn ⇒ Integer

  BGP autonomous system number.

• #bestpath_always_compare_med ⇒ Symbol^?

  Enable/Disable MED comparison on paths from different autonomous systems.

• #bestpath_aspath_multipath_relax ⇒ Symbol^?

  Enable/Disable load sharing across the providers with different (but equal-length) AS paths.

• #bestpath_compare_neighborid ⇒ Symbol^?

  Enable/Disable neighborid.

• #bestpath_compare_routerid ⇒ Symbol^?

  Enable/Disable comparison of router IDs for identical eBGP paths.

• #bestpath_cost_community_ignore ⇒ Symbol^?

  Enable/Disable Ignores the cost community for BGP best-path calculations.

• #bestpath_med_confed ⇒ Symbol^?

  Enable/Disable enforcement of bestpath to do a MED comparison only between paths originated within a confederation.

• #bestpath_med_missing_as_worst ⇒ Symbol^?

  Enable/Disable assigns the value of infinity to received routes that do not carry the MED attribute, making these routes the least desirable.

• #bestpath_med_non_deterministic ⇒ Symbol^?

  Enable/Disable deterministic selection of the best MED pat from among the paths from the same autonomous system.

• #cluster_id ⇒ Object^?

  Route Reflector Cluster-ID.

• #confederation_id ⇒ Object^?

  Routing domain confederation AS.

• #confederation_peers ⇒ Object^?

  AS confederation parameters.

• #disable_policy_batching ⇒ Symbol^?

  Enable/Disable the batching evaluation of prefix advertisement to all peers.

• #disable_policy_batching_ipv4_prefix_list ⇒ Object^?

  Enable/Disable the batching evaluation of prefix advertisements to all peers with prefix list.

• #disable_policy_batching_ipv6_prefix_list ⇒ Object^?

  Enable/Disable the batching evaluation of prefix advertisements to all peers with prefix list.

• #enforce_first_as ⇒ Symbol^?

  Enable/Disable enforces the neighbor autonomous system to be the first AS number listed in the AS path attribute for eBGP.

• #event_history_cli ⇒ :size_small, ...

  Enable/Disable cli event history buffer.

• #event_history_detail ⇒ :size_small, ...

  Enable/Disable detail event history buffer.

• #event_history_events ⇒ :size_small, ...

  Enable/Disable event history buffer.

• #event_history_periodic ⇒ :size_small, ...

  Enable/Disable periodic event history buffer.

• #fast_external_fallover ⇒ Symbol^?

  Enable/Disable immediately reset the session if the link to a directly connected BGP peer goes down.

• #flush_routes ⇒ Symbol^?

  Enable/Disable flush routes in RIB upon controlled restart.

• #graceful_restart ⇒ Symbol^?

  Enable/Disable graceful restart.

• #graceful_restart_helper ⇒ Symbol^?

  Enable/Disable graceful restart helper mode.

• #graceful_restart_timers_restart ⇒ Object^?

  Set maximum time for a restart sent to the BGP peer.

• #graceful_restart_timers_stalepath_time ⇒ Object^?

  Set maximum time that BGP keeps the stale routes from the restarting BGP peer.

• #isolate ⇒ Symbol^?

  Enable/Disable isolate this router from BGP perspective.

• #local_as ⇒ Object^?

  Local AS number to be used within a VRF instance.

• #log_neighbor_changes ⇒ Symbol^?

  Enable/Disable message logging for neighbor up/down event.

• #maxas_limit ⇒ Object^?

  Specify Maximum number of AS numbers allowed in the AS-path attribute.

• #neighbor_down_fib_accelerate ⇒ Symbol^?

  Enable/Disable handle BGP neighbor down event, due to various reasons.

• #reconnect_interval ⇒ Object^?

  The BGP reconnection interval for dropped sessions.

• #router_id ⇒ String^?

  Router Identifier (ID) of the BGP router VRF instance.

• #shutdown ⇒ Symbol^?

  Administratively shutdown the BGP protocol.

• #state ⇒ :present, ...

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

• #suppress_fib_pending ⇒ Symbol^?

  Enable/Disable advertise only routes programmed in hardware to peers.

• #timer_bestpath_limit ⇒ Object^?

  Specify timeout for the first best path after a restart, in seconds.

• #timer_bgp_hold ⇒ Object^?

  Set BGP hold timer.

• #timer_bgp_keepalive ⇒ Object^?

  Set BGP keepalive timer.

• #vrf ⇒ String^?

  Name of the VRF.

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

#asn ⇒ Integer

Returns BGP autonomous system number. Valid values are String, Integer in ASPLAIN or ASDOT notation.

Returns:

• (Integer) —

  BGP autonomous system number. Valid values are String, Integer in ASPLAIN or ASDOT notation.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 12

attribute :asn

#bestpath_always_compare_med ⇒ Symbol^?

Returns Enable/Disable MED comparison on paths from different autonomous systems.

Returns:

• (Symbol, nil) —

  Enable/Disable MED comparison on paths from different autonomous systems.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 20

attribute :bestpath_always_compare_med

#bestpath_aspath_multipath_relax ⇒ Symbol^?

Returns Enable/Disable load sharing across the providers with different (but equal-length) AS paths.

Returns:

• (Symbol, nil) —

  Enable/Disable load sharing across the providers with different (but equal-length) AS paths.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 24

attribute :bestpath_aspath_multipath_relax

#bestpath_compare_neighborid ⇒ Symbol^?

Returns Enable/Disable neighborid. Use this when more paths available than max path config.

Returns:

• (Symbol, nil) —

  Enable/Disable neighborid. Use this when more paths available than max path config.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 32

attribute :bestpath_compare_neighborid

#bestpath_compare_routerid ⇒ Symbol^?

Returns Enable/Disable comparison of router IDs for identical eBGP paths.

Returns:

• (Symbol, nil) —

  Enable/Disable comparison of router IDs for identical eBGP paths.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 28

attribute :bestpath_compare_routerid

#bestpath_cost_community_ignore ⇒ Symbol^?

Returns Enable/Disable Ignores the cost community for BGP best-path calculations.

Returns:

• (Symbol, nil) —

  Enable/Disable Ignores the cost community for BGP best-path calculations.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 36

attribute :bestpath_cost_community_ignore

#bestpath_med_confed ⇒ Symbol^?

Returns Enable/Disable enforcement of bestpath to do a MED comparison only between paths originated within a confederation.

Returns:

• (Symbol, nil) —

  Enable/Disable enforcement of bestpath to do a MED comparison only between paths originated within a confederation.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 40

attribute :bestpath_med_confed

#bestpath_med_missing_as_worst ⇒ Symbol^?

Returns Enable/Disable assigns the value of infinity to received routes that do not carry the MED attribute, making these routes the least desirable.

Returns:

• (Symbol, nil) —

  Enable/Disable assigns the value of infinity to received routes that do not carry the MED attribute, making these routes the least desirable.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 44

attribute :bestpath_med_missing_as_worst

#bestpath_med_non_deterministic ⇒ Symbol^?

Returns Enable/Disable deterministic selection of the best MED pat from among the paths from the same autonomous system.

Returns:

• (Symbol, nil) —

  Enable/Disable deterministic selection of the best MED pat from among the paths from the same autonomous system.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 48

attribute :bestpath_med_non_deterministic

#cluster_id ⇒ Object^?

Returns Route Reflector Cluster-ID.

Returns:

• (Object, nil) —

  Route Reflector Cluster-ID.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 52

attribute :cluster_id

#confederation_id ⇒ Object^?

Returns Routing domain confederation AS.

Returns:

• (Object, nil) —

  Routing domain confederation AS.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 55

attribute :confederation_id

#confederation_peers ⇒ Object^?

Returns AS confederation parameters.

Returns:

• (Object, nil) —

  AS confederation parameters.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 58

attribute :confederation_peers

#disable_policy_batching ⇒ Symbol^?

Returns Enable/Disable the batching evaluation of prefix advertisement to all peers.

Returns:

• (Symbol, nil) —

  Enable/Disable the batching evaluation of prefix advertisement to all peers.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 61

attribute :disable_policy_batching

#disable_policy_batching_ipv4_prefix_list ⇒ Object^?

Returns Enable/Disable the batching evaluation of prefix advertisements to all peers with prefix list.

Returns:

• (Object, nil) —

  Enable/Disable the batching evaluation of prefix advertisements to all peers with prefix list.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 65

attribute :disable_policy_batching_ipv4_prefix_list

#disable_policy_batching_ipv6_prefix_list ⇒ Object^?

Returns Enable/Disable the batching evaluation of prefix advertisements to all peers with prefix list.

Returns:

• (Object, nil) —

  Enable/Disable the batching evaluation of prefix advertisements to all peers with prefix list.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 68

attribute :disable_policy_batching_ipv6_prefix_list

#enforce_first_as ⇒ Symbol^?

Returns Enable/Disable enforces the neighbor autonomous system to be the first AS number listed in the AS path attribute for eBGP. On NX-OS, this property is only supported in the global BGP context.

Returns:

• (Symbol, nil) —

  Enable/Disable enforces the neighbor autonomous system to be the first AS number listed in the AS path attribute for eBGP. On NX-OS, this property is only supported in the global BGP context.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 71

attribute :enforce_first_as

#event_history_cli ⇒ :size_small, ...

Returns Enable/Disable cli event history buffer.

Returns:

• (:size_small, :size_medium, :size_large, :size_disable, :default, nil) —

  Enable/Disable cli event history buffer.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 75

attribute :event_history_cli

#event_history_detail ⇒ :size_small, ...

Returns Enable/Disable detail event history buffer.

Returns:

• (:size_small, :size_medium, :size_large, :size_disable, :default, nil) —

  Enable/Disable detail event history buffer.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 79

attribute :event_history_detail

#event_history_events ⇒ :size_small, ...

Returns Enable/Disable event history buffer.

Returns:

• (:size_small, :size_medium, :size_large, :size_disable, :default, nil) —

  Enable/Disable event history buffer.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 83

attribute :event_history_events

#event_history_periodic ⇒ :size_small, ...

Returns Enable/Disable periodic event history buffer.

Returns:

• (:size_small, :size_medium, :size_large, :size_disable, :default, nil) —

  Enable/Disable periodic event history buffer.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 87

attribute :event_history_periodic

#fast_external_fallover ⇒ Symbol^?

Returns Enable/Disable immediately reset the session if the link to a directly connected BGP peer goes down. Only supported in the global BGP context.

Returns:

• (Symbol, nil) —

  Enable/Disable immediately reset the session if the link to a directly connected BGP peer goes down. Only supported in the global BGP context.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 91

attribute :fast_external_fallover

#flush_routes ⇒ Symbol^?

Returns Enable/Disable flush routes in RIB upon controlled restart. On NX-OS, this property is only supported in the global BGP context.

Returns:

• (Symbol, nil) —

  Enable/Disable flush routes in RIB upon controlled restart. On NX-OS, this property is only supported in the global BGP context.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 95

attribute :flush_routes

#graceful_restart ⇒ Symbol^?

Returns Enable/Disable graceful restart.

Returns:

• (Symbol, nil) —

  Enable/Disable graceful restart.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 99

attribute :graceful_restart

#graceful_restart_helper ⇒ Symbol^?

Returns Enable/Disable graceful restart helper mode.

Returns:

• (Symbol, nil) —

  Enable/Disable graceful restart helper mode.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 103

attribute :graceful_restart_helper

#graceful_restart_timers_restart ⇒ Object^?

Returns Set maximum time for a restart sent to the BGP peer.

Returns:

• (Object, nil) —

  Set maximum time for a restart sent to the BGP peer.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 107

attribute :graceful_restart_timers_restart

#graceful_restart_timers_stalepath_time ⇒ Object^?

Returns Set maximum time that BGP keeps the stale routes from the restarting BGP peer.

Returns:

• (Object, nil) —

  Set maximum time that BGP keeps the stale routes from the restarting BGP peer.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 110

attribute :graceful_restart_timers_stalepath_time

#isolate ⇒ Symbol^?

Returns Enable/Disable isolate this router from BGP perspective.

Returns:

• (Symbol, nil) —

  Enable/Disable isolate this router from BGP perspective.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 113

attribute :isolate

#local_as ⇒ Object^?

Returns Local AS number to be used within a VRF instance.

Returns:

• (Object, nil) —

  Local AS number to be used within a VRF instance.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 117

attribute :local_as

#log_neighbor_changes ⇒ Symbol^?

Returns Enable/Disable message logging for neighbor up/down event.

Returns:

• (Symbol, nil) —

  Enable/Disable message logging for neighbor up/down event.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 120

attribute :log_neighbor_changes

#maxas_limit ⇒ Object^?

Returns Specify Maximum number of AS numbers allowed in the AS-path attribute. Valid values are between 1 and 512.

Returns:

• (Object, nil) —

  Specify Maximum number of AS numbers allowed in the AS-path attribute. Valid values are between 1 and 512.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 124

attribute :maxas_limit

#neighbor_down_fib_accelerate ⇒ Symbol^?

Returns Enable/Disable handle BGP neighbor down event, due to various reasons.

Returns:

• (Symbol, nil) —

  Enable/Disable handle BGP neighbor down event, due to various reasons.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 127

attribute :neighbor_down_fib_accelerate

#reconnect_interval ⇒ Object^?

Returns The BGP reconnection interval for dropped sessions. Valid values are between 1 and 60.

Returns:

• (Object, nil) —

  The BGP reconnection interval for dropped sessions. Valid values are between 1 and 60.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 131

attribute :reconnect_interval

#router_id ⇒ String^?

Returns Router Identifier (ID) of the BGP router VRF instance.

Returns:

• (String, nil) —

  Router Identifier (ID) of the BGP router VRF instance.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 134

attribute :router_id

#shutdown ⇒ Symbol^?

Returns Administratively shutdown the BGP protocol.

Returns:

• (Symbol, nil) —

  Administratively shutdown the BGP protocol.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 138

attribute :shutdown

#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.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 155

attribute :state

#suppress_fib_pending ⇒ Symbol^?

Returns Enable/Disable advertise only routes programmed in hardware to peers.

Returns:

• (Symbol, nil) —

  Enable/Disable advertise only routes programmed in hardware to peers.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 142

attribute :suppress_fib_pending

#timer_bestpath_limit ⇒ Object^?

Returns Specify timeout for the first best path after a restart, in seconds.

Returns:

• (Object, nil) —

  Specify timeout for the first best path after a restart, in seconds.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 146

attribute :timer_bestpath_limit

#timer_bgp_hold ⇒ Object^?

Returns Set BGP hold timer.

Returns:

• (Object, nil) —

  Set BGP hold timer.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 149

attribute :timer_bgp_hold

#timer_bgp_keepalive ⇒ Object^?

Returns Set BGP keepalive timer.

Returns:

• (Object, nil) —

  Set BGP keepalive timer.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 152

attribute :timer_bgp_keepalive

#vrf ⇒ String^?

Returns Name of the VRF. The name ‘default’ is a valid VRF representing the global BGP.

Returns:

• (String, nil) —

  Name of the VRF. The name ‘default’ is a valid VRF representing the global BGP.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp.rb', line 16

attribute :vrf