Class: Ansible::Ruby::Modules::Nxos_bgp_af

Inherits:

Base

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

Defined in:

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

Overview

Manages BGP Address-family configurations on NX-OS switches.

Instance Method Summary

• #additional_paths_install ⇒ Symbol^?

  Install a backup path into the forwarding table and provide prefix independent convergence (PIC) in case of a PE-CE link failure.

• #additional_paths_receive ⇒ Symbol^?

  Enables the receive capability of additional paths for all of the neighbors under this address family for which the capability has not been disabled.

• #additional_paths_selection ⇒ Object^?

  Configures the capability of selecting additional paths for a prefix.

• #additional_paths_send ⇒ Symbol^?

  Enables the send capability of additional paths for all of the neighbors under this address family for which the capability has not been disabled.

• #advertise_l2vpn_evpn ⇒ Symbol^?

  Advertise evpn routes.

• #afi ⇒ :ipv4, ...

  Address Family Identifier.

• #asn ⇒ Integer

  BGP autonomous system number.

• #client_to_client ⇒ Symbol^?

  Configure client-to-client route reflection.

• #dampen_igp_metric ⇒ Object^?

  Specify dampen value for IGP metric-related changes, in seconds.

• #dampening_half_time ⇒ Object^?

  Specify decay half-life in minutes for route-flap dampening.

• #dampening_max_suppress_time ⇒ Object^?

  Specify max suppress time for route-flap dampening stable route.

• #dampening_reuse_time ⇒ Object^?

  Specify route reuse time for route-flap dampening.

• #dampening_routemap ⇒ Object^?

  Specify route-map for route-flap dampening.

• #dampening_state ⇒ Symbol^?

  Enable/disable route-flap dampening.

• #dampening_suppress_time ⇒ Object^?

  Specify route suppress time for route-flap dampening.

• #default_information_originate ⇒ Symbol^?

  Default information originate.

• #default_metric ⇒ Object^?

  Sets default metrics for routes redistributed into BGP.

• #distance_ebgp ⇒ Object^?

  Sets the administrative distance for eBGP routes.

• #distance_ibgp ⇒ Object^?

  Sets the administrative distance for iBGP routes.

• #distance_local ⇒ Object^?

  Sets the administrative distance for local BGP routes.

• #inject_map ⇒ Object^?

  An array of route-map names which will specify prefixes to inject.

• #maximum_paths ⇒ Object^?

  Configures the maximum number of equal-cost paths for load sharing.

• #maximum_paths_ibgp ⇒ Object^?

  Configures the maximum number of ibgp equal-cost paths for load sharing.

• #networks ⇒ Object^?

  Networks to configure.

• #next_hop_route_map ⇒ Object^?

  Configure a route-map for valid nexthops.

• #redistribute ⇒ Object^?

  A list of redistribute directives.

• #safi ⇒ :unicast, ...

  Sub Address Family Identifier.

• #state ⇒ :present, ...

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

• #suppress_inactive ⇒ Symbol^?

  Advertises only active routes to peers.

• #table_map ⇒ Object^?

  Apply table-map to filter routes downloaded into URIB.

• #table_map_filter ⇒ Symbol^?

  Filters routes rejected by the route-map and does not download them to the RIB.

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

#additional_paths_install ⇒ Symbol^?

Returns Install a backup path into the forwarding table and provide prefix independent convergence (PIC) in case of a PE-CE link failure.

Returns:

• (Symbol, nil) —

  Install a backup path into the forwarding table and provide prefix independent convergence (PIC) in case of a PE-CE link failure.

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

attribute :additional_paths_install

#additional_paths_receive ⇒ Symbol^?

Returns Enables the receive capability of additional paths for all of the neighbors under this address family for which the capability has not been disabled.

Returns:

• (Symbol, nil) —

  Enables the receive capability of additional paths for all of the neighbors under this address family for which the capability has not been disabled.

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

attribute :additional_paths_receive

#additional_paths_selection ⇒ Object^?

Returns Configures the capability of selecting additional paths for a prefix. Valid values are a string defining the name of the route-map.

Returns:

• (Object, nil) —

  Configures the capability of selecting additional paths for a prefix. Valid values are a string defining the name of the route-map.

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

attribute :additional_paths_selection

#additional_paths_send ⇒ Symbol^?

Returns Enables the send capability of additional paths for all of the neighbors under this address family for which the capability has not been disabled.

Returns:

• (Symbol, nil) —

  Enables the send capability of additional paths for all of the neighbors under this address family for which the capability has not been disabled.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_af.rb', line 39

attribute :additional_paths_send

#advertise_l2vpn_evpn ⇒ Symbol^?

Returns Advertise evpn routes.

Returns:

• (Symbol, nil) —

  Advertise evpn routes.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_af.rb', line 43

attribute :advertise_l2vpn_evpn

#afi ⇒ :ipv4, ...

Returns Address Family Identifier.

Returns:

• (:ipv4, :ipv6, :vpnv4, :vpnv6, :l2vpn) —

  Address Family Identifier.

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

attribute :afi

#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_af.rb', line 12

attribute :asn

#client_to_client ⇒ Symbol^?

Returns Configure client-to-client route reflection.

Returns:

• (Symbol, nil) —

  Configure client-to-client route reflection.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_af.rb', line 47

attribute :client_to_client

#dampen_igp_metric ⇒ Object^?

Returns Specify dampen value for IGP metric-related changes, in seconds. Valid values are integer and keyword ‘default’.

Returns:

• (Object, nil) —

  Specify dampen value for IGP metric-related changes, in seconds. Valid values are integer and keyword ‘default’.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_af.rb', line 51

attribute :dampen_igp_metric

#dampening_half_time ⇒ Object^?

Returns Specify decay half-life in minutes for route-flap dampening. Valid values are integer and keyword ‘default’.

Returns:

• (Object, nil) —

  Specify decay half-life in minutes for route-flap dampening. Valid values are integer and keyword ‘default’.

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

attribute :dampening_half_time

#dampening_max_suppress_time ⇒ Object^?

Returns Specify max suppress time for route-flap dampening stable route. Valid values are integer and keyword ‘default’.

Returns:

• (Object, nil) —

  Specify max suppress time for route-flap dampening stable route. Valid values are integer and keyword ‘default’.

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

attribute :dampening_max_suppress_time

#dampening_reuse_time ⇒ Object^?

Returns Specify route reuse time for route-flap dampening. Valid values are integer and keyword ‘default’.

Returns:

• (Object, nil) —

  Specify route reuse time for route-flap dampening. Valid values are integer and keyword ‘default’.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_af.rb', line 64

attribute :dampening_reuse_time

#dampening_routemap ⇒ Object^?

Returns Specify route-map for route-flap dampening. Valid values are a string defining the name of the route-map.

Returns:

• (Object, nil) —

  Specify route-map for route-flap dampening. Valid values are a string defining the name of the route-map.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_af.rb', line 67

attribute :dampening_routemap

#dampening_state ⇒ Symbol^?

Returns Enable/disable route-flap dampening.

Returns:

• (Symbol, nil) —

  Enable/disable route-flap dampening.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_af.rb', line 54

attribute :dampening_state

#dampening_suppress_time ⇒ Object^?

Returns Specify route suppress time for route-flap dampening. Valid values are integer and keyword ‘default’.

Returns:

• (Object, nil) —

  Specify route suppress time for route-flap dampening. Valid values are integer and keyword ‘default’.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_af.rb', line 70

attribute :dampening_suppress_time

#default_information_originate ⇒ Symbol^?

Returns Default information originate.

Returns:

• (Symbol, nil) —

  Default information originate.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_af.rb', line 73

attribute :default_information_originate

#default_metric ⇒ Object^?

Returns Sets default metrics for routes redistributed into BGP. Valid values are Integer or keyword ‘default’.

Returns:

• (Object, nil) —

  Sets default metrics for routes redistributed into BGP. Valid values are Integer or keyword ‘default’

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_af.rb', line 77

attribute :default_metric

#distance_ebgp ⇒ Object^?

Returns Sets the administrative distance for eBGP routes. Valid values are Integer or keyword ‘default’.

Returns:

• (Object, nil) —

  Sets the administrative distance for eBGP routes. Valid values are Integer or keyword ‘default’.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_af.rb', line 80

attribute :distance_ebgp

#distance_ibgp ⇒ Object^?

Returns Sets the administrative distance for iBGP routes. Valid values are Integer or keyword ‘default’.

Returns:

• (Object, nil) —

  Sets the administrative distance for iBGP routes. Valid values are Integer or keyword ‘default’.

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

attribute :distance_ibgp

#distance_local ⇒ Object^?

Returns Sets the administrative distance for local BGP routes. Valid values are Integer or keyword ‘default’.

Returns:

• (Object, nil) —

  Sets the administrative distance for local BGP routes. Valid values are Integer or keyword ‘default’.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_af.rb', line 86

attribute :distance_local

#inject_map ⇒ Object^?

Returns An array of route-map names which will specify prefixes to inject. Each array entry must first specify the inject-map name, secondly an exist-map name, and optionally the copy-attributes keyword which indicates that attributes should be copied from the aggregate. For example [[‘lax_inject_map’, ‘lax_exist_map’], [‘nyc_inject_map’, ‘nyc_exist_map’, ‘copy-attributes’], [‘fsd_inject_map’, ‘fsd_exist_map’]].

Returns:

• (Object, nil) —

  An array of route-map names which will specify prefixes to inject. Each array entry must first specify the inject-map name, secondly an exist-map name, and optionally the copy-attributes keyword which indicates that attributes should be copied from the aggregate. For example [[‘lax_inject_map’, ‘lax_exist_map’], [‘nyc_inject_map’, ‘nyc_exist_map’, ‘copy-attributes’], [‘fsd_inject_map’, ‘fsd_exist_map’]].

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_af.rb', line 89

attribute :inject_map

#maximum_paths ⇒ Object^?

Returns Configures the maximum number of equal-cost paths for load sharing. Valid value is an integer in the range 1-64.

Returns:

• (Object, nil) —

  Configures the maximum number of equal-cost paths for load sharing. Valid value is an integer in the range 1-64.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_af.rb', line 92

attribute :maximum_paths

#maximum_paths_ibgp ⇒ Object^?

Returns Configures the maximum number of ibgp equal-cost paths for load sharing. Valid value is an integer in the range 1-64.

Returns:

• (Object, nil) —

  Configures the maximum number of ibgp equal-cost paths for load sharing. Valid value is an integer in the range 1-64.

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

attribute :maximum_paths_ibgp

#networks ⇒ Object^?

Returns Networks to configure. Valid value is a list of network prefixes to advertise. The list must be in the form of an array. Each entry in the array must include a prefix address and an optional route-map. For example [[‘10.0.0.0/16’, ‘routemap_LA’], [‘192.168.1.1’, ‘Chicago’], [‘192.168.2.0/24’], [‘192.168.3.0/24’, ‘routemap_NYC’]].

Returns:

• (Object, nil) —

  Networks to configure. Valid value is a list of network prefixes to advertise. The list must be in the form of an array. Each entry in the array must include a prefix address and an optional route-map. For example [[‘10.0.0.0/16’, ‘routemap_LA’], [‘192.168.1.1’, ‘Chicago’], [‘192.168.2.0/24’], [‘192.168.3.0/24’, ‘routemap_NYC’]].

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_af.rb', line 98

attribute :networks

#next_hop_route_map ⇒ Object^?

Returns Configure a route-map for valid nexthops. Valid values are a string defining the name of the route-map.

Returns:

• (Object, nil) —

  Configure a route-map for valid nexthops. Valid values are a string defining the name of the route-map.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_af.rb', line 101

attribute :next_hop_route_map

#redistribute ⇒ Object^?

Returns A list of redistribute directives. Multiple redistribute entries are allowed. The list must be in the form of a nested array. the first entry of each array defines the source-protocol to redistribute from; the second entry defines a route-map name. A route-map is highly advised but may be optional on some platforms, in which case it may be omitted from the array list. For example [[‘direct’, ‘rm_direct’], [‘lisp’, ‘rm_lisp’]].

Returns:

• (Object, nil) —

  A list of redistribute directives. Multiple redistribute entries are allowed. The list must be in the form of a nested array. the first entry of each array defines the source-protocol to redistribute from; the second entry defines a route-map name. A route-map is highly advised but may be optional on some platforms, in which case it may be omitted from the array list. For example [[‘direct’, ‘rm_direct’], [‘lisp’, ‘rm_lisp’]].

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_af.rb', line 104

attribute :redistribute

#safi ⇒ :unicast, ...

Returns Sub Address Family Identifier.

Returns:

• (:unicast, :multicast, :evpn) —

  Sub Address Family Identifier.

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

attribute :safi

#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_af.rb', line 118

attribute :state

#suppress_inactive ⇒ Symbol^?

Returns Advertises only active routes to peers.

Returns:

• (Symbol, nil) —

  Advertises only active routes to peers.

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

attribute :suppress_inactive

#table_map ⇒ Object^?

Returns Apply table-map to filter routes downloaded into URIB. Valid values are a string.

Returns:

• (Object, nil) —

  Apply table-map to filter routes downloaded into URIB. Valid values are a string.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_af.rb', line 111

attribute :table_map

#table_map_filter ⇒ Symbol^?

Returns Filters routes rejected by the route-map and does not download them to the RIB.

Returns:

• (Symbol, nil) —

  Filters routes rejected by the route-map and does not download them to the RIB.

# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_af.rb', line 114

attribute :table_map_filter

#vrf ⇒ String

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

Returns:

• (String) —

  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_af.rb', line 16

attribute :vrf