Class: Ansible::Ruby::Modules::Nxos_bgp_neighbor

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

Overview

Manages BGP 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

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

attribute :asn

#capability_negotiation ⇒ Symbol?

Returns Configure whether or not to negotiate capability with this neighbor.

Returns:

  • (Symbol, nil) —

    Configure whether or not to negotiate capability with this neighbor.



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

attribute :capability_negotiation

#connected_check ⇒ Symbol?

Returns Configure whether or not to check for directly connected peer.

Returns:

  • (Symbol, nil) —

    Configure whether or not to check for directly connected peer.



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

attribute :connected_check

#description ⇒ String?

Returns Description of the neighbor.

Returns:

  • (String, nil) —

    Description of the neighbor.



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

attribute :description

#dynamic_capability ⇒ Symbol?

Returns Configure whether or not to enable dynamic capability.

Returns:

  • (Symbol, nil) —

    Configure whether or not to enable dynamic capability.



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

attribute :dynamic_capability

#ebgp_multihop ⇒ Object?

Returns Specify multihop TTL for a remote peer. Valid values are integers between 2 and 255, or keyword ‘default’ to disable this property.

Returns:

  • (Object, nil) —

    Specify multihop TTL for a remote peer. Valid values are integers between 2 and 255, or keyword ‘default’ to disable this property.



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

attribute :ebgp_multihop

#local_as ⇒ Integer?

Returns Specify the local-as number for the eBGP neighbor. Valid values are String or Integer in ASPLAIN or ASDOT notation, or ‘default’, which means not to configure it.

Returns:

  • (Integer, nil) —

    Specify the local-as number for the eBGP neighbor. Valid values are String or Integer in ASPLAIN or ASDOT notation, or ‘default’, which means not to configure it.



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

attribute :local_as

#log_neighbor_changes ⇒ :enable, ...

Returns Specify whether or not to enable log messages for neighbor up/down event.

Returns:

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

    Specify whether or not to enable log messages for neighbor up/down event.



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

attribute :log_neighbor_changes

#low_memory_exempt ⇒ Symbol?

Returns Specify whether or not to shut down this neighbor under memory pressure.

Returns:

  • (Symbol, nil) —

    Specify whether or not to shut down this neighbor under memory pressure.



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

attribute :low_memory_exempt

#maximum_peers ⇒ Object?

Returns Specify Maximum number of peers for this neighbor prefix Valid values are between 1 and 1000, or ‘default’, which does not impose the limit. Note that this parameter is accepted only on neighbors with address/prefix.

Returns:

  • (Object, nil) —

    Specify Maximum number of peers for this neighbor prefix Valid values are between 1 and 1000, or ‘default’, which does not impose the limit. Note that this parameter is accepted only on neighbors with address/prefix.



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

attribute :maximum_peers

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

attribute :neighbor

#pwd ⇒ Object?

Returns Specify the password for neighbor. Valid value is string.

Returns:

  • (Object, nil) —

    Specify the password for neighbor. Valid value is string.



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

attribute :pwd

#pwd_type ⇒ :"3des", ...

Returns Specify the encryption type the password will use. Valid values are ‘3des’ or ‘cisco_type_7’ encryption or keyword ‘default’.

Returns:

  • (:"3des", :cisco_type_7, :default, nil) —

    Specify the encryption type the password will use. Valid values are ‘3des’ or ‘cisco_type_7’ encryption or keyword ‘default’.



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

attribute :pwd_type

#remote_as ⇒ Integer?

Returns Specify Autonomous System Number of the neighbor. Valid values are String or Integer in ASPLAIN or ASDOT notation, or ‘default’, which means not to configure it.

Returns:

  • (Integer, nil) —

    Specify Autonomous System Number of the neighbor. Valid values are String or Integer in ASPLAIN or ASDOT notation, or ‘default’, which means not to configure it.



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

attribute :remote_as

#remove_private_as ⇒ :enable, ...

Returns Specify the config to remove private AS number from outbound updates. Valid values are ‘enable’ to enable this config, ‘disable’ to disable this config, ‘all’ to remove all private AS number, or ‘replace-as’, to replace the private AS number.

Returns:

  • (:enable, :disable, :all, :"replace-as", nil) —

    Specify the config to remove private AS number from outbound updates. Valid values are ‘enable’ to enable this config, ‘disable’ to disable this config, ‘all’ to remove all private AS number, or ‘replace-as’, to replace the private AS number.



69
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_neighbor.rb', line 69

attribute :remove_private_as

#shutdown ⇒ Symbol?

Returns Configure to administratively shutdown this neighbor.

Returns:

  • (Symbol, nil) —

    Configure to administratively shutdown this neighbor.



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

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.



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

attribute :state

#suppress_4_byte_as ⇒ Symbol?

Returns Configure to suppress 4-byte AS Capability.

Returns:

  • (Symbol, nil) —

    Configure to suppress 4-byte AS Capability.



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

attribute :suppress_4_byte_as

#timers_holdtime ⇒ Object?

Returns Specify holdtime timer value. Valid values are integers between 0 and 3600 in terms of seconds, or ‘default’, which is 180.

Returns:

  • (Object, nil) —

    Specify holdtime timer value. Valid values are integers between 0 and 3600 in terms of seconds, or ‘default’, which is 180.



84
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_neighbor.rb', line 84

attribute :timers_holdtime

#timers_keepalive ⇒ Object?

Returns Specify keepalive timer value. Valid values are integers between 0 and 3600 in terms of seconds, or ‘default’, which is 60.

Returns:

  • (Object, nil) —

    Specify keepalive timer value. Valid values are integers between 0 and 3600 in terms of seconds, or ‘default’, which is 60.



81
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_bgp_neighbor.rb', line 81

attribute :timers_keepalive

#transport_passive_only ⇒ Symbol?

Returns Specify whether or not to only allow passive connection setup. Valid values are ‘true’, ‘false’, and ‘default’, which defaults to ‘false’. This property can only be configured when the neighbor is in ‘ip’ address format without prefix length.

Returns:

  • (Symbol, nil) —

    Specify whether or not to only allow passive connection setup. Valid values are ‘true’, ‘false’, and ‘default’, which defaults to ‘false’. This property can only be configured when the neighbor is in ‘ip’ address format without prefix length.



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

attribute :transport_passive_only

#update_source ⇒ String?

Returns Specify source interface of BGP session and updates.

Returns:

  • (String, nil) —

    Specify source interface of BGP session and updates.



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

attribute :update_source

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

attribute :vrf