Class: Ansible::Ruby::Modules::Nxos_bgp_neighbor_af

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

Overview

Manages BGP address-family’s neighbors configurations on NX-OS 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

#additional_paths_receive ⇒ :enable, ...

Returns Valid values are enable for basic command enablement; disable for disabling the command at the neighbor af level (it adds the disable keyword to the basic command); and inherit to remove the command at this level (the command value is inherited from a higher BGP layer).

Returns:

  • (:enable, :disable, :inherit, nil) —

    Valid values are enable for basic command enablement; disable for disabling the command at the neighbor af level (it adds the disable keyword to the basic command); and inherit to remove the command at this level (the command value is inherited from a higher BGP layer).



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

attribute :additional_paths_receive

#additional_paths_send ⇒ :enable, ...

Returns Valid values are enable for basic command enablement; disable for disabling the command at the neighbor af level (it adds the disable keyword to the basic command); and inherit to remove the command at this level (the command value is inherited from a higher BGP layer).

Returns:

  • (:enable, :disable, :inherit, nil) —

    Valid values are enable for basic command enablement; disable for disabling the command at the neighbor af level (it adds the disable keyword to the basic command); and inherit to remove the command at this level (the command value is inherited from a higher BGP layer).



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

attribute :additional_paths_send

Returns Conditional route advertisement. This property requires two route maps, an advertise-map and an exist-map. Valid values are an array specifying both the advertise-map name and the exist-map name, or simply ‘default’ e.g. [‘my_advertise_map’, ‘my_exist_map’]. This command is mutually exclusive with the advertise_map_non_exist property.

Returns:

  • (Object, nil) —

    Conditional route advertisement. This property requires two route maps, an advertise-map and an exist-map. Valid values are an array specifying both the advertise-map name and the exist-map name, or simply ‘default’ e.g. [‘my_advertise_map’, ‘my_exist_map’]. This command is mutually exclusive with the advertise_map_non_exist property.



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

attribute :advertise_map_exist

Returns Conditional route advertisement. This property requires two route maps, an advertise-map and an exist-map. Valid values are an array specifying both the advertise-map name and the non-exist-map name, or simply ‘default’ e.g. [‘my_advertise_map’, ‘my_non_exist_map’]. This command is mutually exclusive with the advertise_map_exist property.

Returns:

  • (Object, nil) —

    Conditional route advertisement. This property requires two route maps, an advertise-map and an exist-map. Valid values are an array specifying both the advertise-map name and the non-exist-map name, or simply ‘default’ e.g. [‘my_advertise_map’, ‘my_non_exist_map’]. This command is mutually exclusive with the advertise_map_exist property.



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

attribute :advertise_map_non_exist

#afi ⇒ :ipv4, ...

Returns Address Family Identifier.

Returns:

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

    Address Family Identifier.



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

attribute :afi

#allowas_in ⇒ Object?

Returns Activate allowas-in property.

Returns:

  • (Object, nil) —

    Activate allowas-in property



46
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_neighbor_af.rb', line 46

attribute :allowas_in

#allowas_in_max ⇒ Object?

Returns Max-occurrences value for allowas_in. Valid values are an integer value or ‘default’. This is mutually exclusive with allowas_in.

Returns:

  • (Object, nil) —

    Max-occurrences value for allowas_in. Valid values are an integer value or ‘default’. This is mutually exclusive with allowas_in.



49
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_neighbor_af.rb', line 49

attribute :allowas_in_max

#as_override ⇒ Symbol?

Returns Activate the as-override feature.

Returns:

  • (Symbol, nil) —

    Activate the as-override feature.



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

attribute :as_override

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



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

attribute :asn

#default_originate ⇒ Symbol?

Returns Activate the default-originate feature.

Returns:

  • (Symbol, nil) —

    Activate the default-originate feature.



56
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_neighbor_af.rb', line 56

attribute :default_originate

#default_originate_route_map ⇒ Object?

Returns Route-map for the default_originate property. Valid values are a string defining a route-map name, or ‘default’. This is mutually exclusive with default_originate.

Returns:

  • (Object, nil) —

    Route-map for the default_originate property. Valid values are a string defining a route-map name, or ‘default’. This is mutually exclusive with default_originate.



60
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_neighbor_af.rb', line 60

attribute :default_originate_route_map

#disable_peer_as_check ⇒ Symbol?

Returns Disable checking of peer AS-number while advertising.

Returns:

  • (Symbol, nil) —

    Disable checking of peer AS-number while advertising



63
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_neighbor_af.rb', line 63

attribute :disable_peer_as_check

#filter_list_in ⇒ Object?

Returns Valid values are a string defining a filter-list name, or ‘default’.

Returns:

  • (Object, nil) —

    Valid values are a string defining a filter-list name, or ‘default’.



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

attribute :filter_list_in

#filter_list_out ⇒ Object?

Returns Valid values are a string defining a filter-list name, or ‘default’.

Returns:

  • (Object, nil) —

    Valid values are a string defining a filter-list name, or ‘default’.



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

attribute :filter_list_out

#max_prefix_interval ⇒ Object?

Returns Optional restart interval. Valid values are an integer. Requires max_prefix_limit. May not be combined with max_prefix_warning.

Returns:

  • (Object, nil) —

    Optional restart interval. Valid values are an integer. Requires max_prefix_limit. May not be combined with max_prefix_warning.



76
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_neighbor_af.rb', line 76

attribute :max_prefix_interval

#max_prefix_limit ⇒ Object?

Returns maximum-prefix limit value. Valid values are an integer value or ‘default’.

Returns:

  • (Object, nil) —

    maximum-prefix limit value. Valid values are an integer value or ‘default’.



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

attribute :max_prefix_limit

#max_prefix_threshold ⇒ Object?

Returns Optional threshold percentage at which to generate a warning. Valid values are an integer value. Requires max_prefix_limit.

Returns:

  • (Object, nil) —

    Optional threshold percentage at which to generate a warning. Valid values are an integer value. Requires max_prefix_limit.



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

attribute :max_prefix_threshold

#max_prefix_warning ⇒ Symbol?

Returns Optional warning-only keyword. Requires max_prefix_limit. May not be combined with max_prefix_interval.

Returns:

  • (Symbol, nil) —

    Optional warning-only keyword. Requires max_prefix_limit. May not be combined with max_prefix_interval.



82
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_neighbor_af.rb', line 82

attribute :max_prefix_warning

#neighbor ⇒ String

Returns Neighbor Identifier. Valid values are string. Neighbors may use IPv4 or IPv6 notation, with or without prefix length.

Returns:

  • (String) —

    Neighbor Identifier. Valid values are string. Neighbors may use IPv4 or IPv6 notation, with or without prefix length.



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

attribute :neighbor

#next_hop_self ⇒ Symbol?

Returns Activate the next-hop-self feature.

Returns:

  • (Symbol, nil) —

    Activate the next-hop-self feature.



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

attribute :next_hop_self

#next_hop_third_party ⇒ Symbol?

Returns Activate the next-hop-third-party feature.

Returns:

  • (Symbol, nil) —

    Activate the next-hop-third-party feature.



90
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_neighbor_af.rb', line 90

attribute :next_hop_third_party

#prefix_list_in ⇒ Object?

Returns Valid values are a string defining a prefix-list name, or ‘default’.

Returns:

  • (Object, nil) —

    Valid values are a string defining a prefix-list name, or ‘default’.



94
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_neighbor_af.rb', line 94

attribute :prefix_list_in

#prefix_list_out ⇒ Object?

Returns Valid values are a string defining a prefix-list name, or ‘default’.

Returns:

  • (Object, nil) —

    Valid values are a string defining a prefix-list name, or ‘default’.



97
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_neighbor_af.rb', line 97

attribute :prefix_list_out

#route_map_in ⇒ Object?

Returns Valid values are a string defining a route-map name, or ‘default’.

Returns:

  • (Object, nil) —

    Valid values are a string defining a route-map name, or ‘default’.



100
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_neighbor_af.rb', line 100

attribute :route_map_in

#route_map_out ⇒ Object?

Returns Valid values are a string defining a route-map name, or ‘default’.

Returns:

  • (Object, nil) —

    Valid values are a string defining a route-map name, or ‘default’.



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

attribute :route_map_out

#route_reflector_client ⇒ Symbol?

Returns Router reflector client.

Returns:

  • (Symbol, nil) —

    Router reflector client.



106
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_neighbor_af.rb', line 106

attribute :route_reflector_client

#safi ⇒ :unicast, ...

Returns Sub Address Family Identifier.

Returns:

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

    Sub Address Family Identifier.



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

attribute :safi

#send_community ⇒ :none, ...

Returns send-community attribute.

Returns:

  • (:none, :both, :extended, :standard, :default, nil) —

    send-community attribute.



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

attribute :send_community

#soft_reconfiguration_in ⇒ :enable, ...

Returns Valid values are ‘enable’ for basic command enablement; ‘always’ to add the always keyword to the basic command; and ‘inherit’ to remove the command at this level (the command value is inherited from a higher BGP layer).

Returns:

  • (:enable, :always, :inherit, nil) —

    Valid values are ‘enable’ for basic command enablement; ‘always’ to add the always keyword to the basic command; and ‘inherit’ to remove the command at this level (the command value is inherited from a higher BGP layer).



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

attribute :soft_reconfiguration_in

#soo ⇒ Object?

Returns Site-of-origin. Valid values are a string defining a VPN extcommunity or ‘default’.

Returns:

  • (Object, nil) —

    Site-of-origin. Valid values are a string defining a VPN extcommunity or ‘default’.



118
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_neighbor_af.rb', line 118

attribute :soo

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



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

attribute :state

#suppress_inactive ⇒ Symbol?

Returns suppress-inactive feature.

Returns:

  • (Symbol, nil) —

    suppress-inactive feature.



121
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_neighbor_af.rb', line 121

attribute :suppress_inactive

#unsuppress_map ⇒ Object?

Returns unsuppress-map. Valid values are a string defining a route-map name or ‘default’.

Returns:

  • (Object, nil) —

    unsuppress-map. Valid values are a string defining a route-map name or ‘default’.



125
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_neighbor_af.rb', line 125

attribute :unsuppress_map

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



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

attribute :vrf

#weight ⇒ Object?

Returns Weight value. Valid values are an integer value or ‘default’.

Returns:

  • (Object, nil) —

    Weight value. Valid values are an integer value or ‘default’.



128
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_neighbor_af.rb', line 128

attribute :weight