diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-18 05:52:27 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-18 05:52:27 +0000 |
| commit | 3b0807ad7b283c46c21862eb826dcbb4ad04e5e2 (patch) | |
| tree | 6461ea75f03eca87a5a90c86c3c9a787a6ad037e /ansible_collections/cisco/nxos/docs | |
| parent | Adding debian version 7.7.0+dfsg-3. (diff) | |
| download | ansible-3b0807ad7b283c46c21862eb826dcbb4ad04e5e2.tar.xz ansible-3b0807ad7b283c46c21862eb826dcbb4ad04e5e2.zip | |
Merging upstream version 9.4.0+dfsg.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/cisco/nxos/docs')
19 files changed, 5506 insertions, 3832 deletions
diff --git a/ansible_collections/cisco/nxos/docs/__init__.py b/ansible_collections/cisco/nxos/docs/__init__.py new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/ansible_collections/cisco/nxos/docs/__init__.py diff --git a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_acls_module.rst b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_acls_module.rst index 1c8801e8b..8a4c23f3d 100644 --- a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_acls_module.rst +++ b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_acls_module.rst @@ -3111,46 +3111,89 @@ Examples # Before state: # ------------- - # + # nxos-9k# show running-config | section '^ip(v6)* access-list' - - name: Merge new ACLs configuration + - name: Merge provided ACLs configuration with device configuration cisco.nxos.nxos_acls: + state: merged config: - - afi: ipv4 - acls: - - name: ACL1v4 - aces: - - grant: deny - destination: - address: 192.0.2.64 - wildcard_bits: 0.0.0.255 - source: - any: true - port_protocol: - lt: 55 - protocol: tcp - protocol_options: - tcp: - ack: true - fin: true - sequence: 50 + - afi: ipv4 + acls: + - name: ACL1v4 + aces: + - grant: deny + destination: + address: 192.0.2.64 + wildcard_bits: 0.0.0.255 + source: + any: true + port_protocol: + lt: 55 + protocol: tcp + protocol_options: + tcp: + ack: true + fin: true + sequence: 50 + + - afi: ipv6 + acls: + - name: ACL1v6 + aces: + - grant: permit + sequence: 10 + source: + any: true + destination: + prefix: 2001:db8:12::/32 + protocol: sctp + + # Task Output + # ----------- + # before: [] + # + # commands: + # - ip access-list ACL1v4 + # - 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin + # - ipv6 access-list ACL1v6 + # - 10 permit sctp any 2001:db8:12::/32 + # + # after: + # - acls: + # - aces: + # - destination: + # prefix: 2001:db8:12::/32 + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # name: ACL1v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # address: 192.0.2.64 + # wildcard_bits: 0.0.0.255 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # fin: true + # sequence: 50 + # source: + # any: true + # port_protocol: + # lt: '55' + # name: ACL1v4 + # afi: ipv4 - - afi: ipv6 - acls: - - name: ACL1v6 - aces: - - grant: permit - sequence: 10 - source: - any: true - destination: - prefix: 2001:db8:12::/32 - protocol: sctp - state: merged # After state: # ------------ # + # nxos-9k# show running-config | section '^ip(v6)* access-list' # ip access-list ACL1v4 # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin # ipv6 access-list ACL1v6 @@ -3160,94 +3203,269 @@ Examples # Before state: # ---------------- - # + # nxos-9k# show running-config | section '^ip(v6)* access-list' # ip access-list ACL1v4 # 10 permit ip any any # 20 deny udp any any # ip access-list ACL2v4 # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ip access-list ACL1v6 + # ipv6 access-list ACL1v6 # 10 permit sctp any any # 20 remark IPv6 ACL - # ip access-list ACL2v6 + # ipv6 access-list ACL2v6 # 10 deny ipv6 any 2001:db8:3000::/36 # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - name: Replace existing ACL configuration with provided configuration cisco.nxos.nxos_acls: config: - - afi: ipv4 - - afi: ipv6 - acls: - - name: ACL1v6 - aces: - - sequence: 20 - grant: permit - source: - any: true - destination: - any: true - protocol: pip - - - remark: Replaced ACE - - - name: ACL2v6 + - afi: ipv4 + - afi: ipv6 + acls: + - name: ACL1v6 + aces: + - sequence: 20 + grant: permit + source: + any: true + destination: + any: true + protocol: pim + + - remark: Replaced ACE + - name: ACL2v6 state: replaced + # Task Output + # ----------- + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # - ipv6 access-list ACL1v6 + # - no 10 permit sctp any any + # - no 20 remark IPv6 ACL + # - remark Replaced ACE + # - 20 permit pim any any + # - ipv6 access-list ACL2v6 + # - no 10 deny ipv6 any 2001:db8:3000::/36 + # - no 20 permit tcp host 2001:db8:2000:2::2 host 2001:db8:2000:ab::2 + # + # after: + # - acls: + # - aces: + # - remark: Replaced ACE + # sequence: 10 + # - destination: + # any: true + # grant: permit + # protocol: pim + # sequence: 20 + # source: + # any: true + # name: ACL1v6 + # - name: ACL2v6 + # afi: ipv6 + # After state: # --------------- - # + # nxos-9k# show running-config | section '^ip(v6)* access-list' # ipv6 access-list ACL1v6 - # 20 permit pip any any - # 30 remark Replaced ACE + # 10 remark Replaced ACE + # 20 permit pim any any # ipv6 access-list ACL2v6 # Using overridden # Before state: # ---------------- - # + # nxos-9k# show running-config | section '^ip(v6)* access-list' # ip access-list ACL1v4 # 10 permit ip any any # 20 deny udp any any # ip access-list ACL2v4 # 10 permit ahp 192.0.2.0 0.0.0.255 any - # ip access-list ACL1v6 + # ipv6 access-list ACL1v6 # 10 permit sctp any any # 20 remark IPv6 ACL - # ip access-list ACL2v6 + # ipv6 access-list ACL2v6 # 10 deny ipv6 any 2001:db8:3000::/36 # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - name: Override existing configuration with provided configuration cisco.nxos.nxos_acls: config: - - afi: ipv4 - acls: - - name: NewACL - aces: - - grant: deny - source: - address: 192.0.2.0 - wildcard_bits: 0.0.255.255 - destination: - any: true - protocol: eigrp - - remark: Example for overridden state + - afi: ipv4 + acls: + - name: NewACL + aces: + - grant: deny + source: + address: 192.0.2.0 + wildcard_bits: 0.0.255.255 + destination: + any: true + protocol: eigrp + - remark: Example for overridden state state: overridden + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ipv6 access-list ACL1v6 + # - no ipv6 access-list ACL2v6 + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # - ip access-list NewACL + # - deny eigrp 192.0.2.0 0.0.255.255 any + # - remark Example for overridden state + # + # after: + # - acls: + # - aces: + # - destination: + # any: true + # grant: deny + # protocol: eigrp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.255.255 + # - remark: Example for overridden state + # sequence: 20 + # name: NewACL + # afi: ipv4 + # After state: # ------------ - # + # nxos-9k# show running-config | section '^ip(v6)* access-list' # ip access-list NewACL # 10 deny eigrp 192.0.2.0 0.0.255.255 any # 20 remark Example for overridden state - # Using deleted: + # Using deleted - delete all # # Before state: # ------------- - # + # nxos-9k# show running-config | section '^ip(v6)* access-list' # ip access-list ACL1v4 # 10 permit ip any any # 20 deny udp any any @@ -3262,17 +3480,89 @@ Examples - name: Delete all ACLs cisco.nxos.nxos_acls: - config: state: deleted + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # - no ipv6 access-list ACL1v6 + # - no ipv6 access-list ACL2v6 + # + # after: [] + + # After state: # ----------- + # nxos-9k# show running-config | section '^ip(v6)* access-list' # + # Using deleted - delete AFI # Before state: # ------------- - # + # nxos-9k# show running-config | section '^ip(v6)* access-list' # ip access-list ACL1v4 # 10 permit ip any any # 20 deny udp any any @@ -3291,9 +3581,106 @@ Examples - afi: ipv4 state: deleted + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # + # after: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # After state: # ------------ - # + # nxos-9k# show running-config | section '^ip(v6)* access-list' # ip access-list ACL1v6 # 10 permit sctp any any # 20 remark IPv6 ACL @@ -3301,11 +3688,11 @@ Examples # 10 deny ipv6 any 2001:db8:3000::/36 # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 - + # Using deleted - delete ACLs # Before state: # ------------- - # + # nxos-9k# show running-config | section '^ip(v6)* access-list' # ip access-list ACL1v4 # 10 permit ip any any # 20 deny udp any any @@ -3320,18 +3707,106 @@ Examples - name: Delete specific ACLs cisco.nxos.nxos_acls: - config: - - afi: ipv4 - acls: - - name: ACL1v4 - - name: ACL2v4 - - afi: ipv6 - acls: - - name: ACL1v6 state: deleted + config: + - afi: ipv4 + acls: + - name: ACL1v4 + - name: ACL2v4 + - afi: ipv6 + acls: + - name: ACL1v6 + + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: sctp + # sequence: 10 + # source: + # any: true + # - remark: IPv6 ACL + # sequence: 20 + # name: ACL1v6 + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # any: true + # - destination: + # any: true + # grant: deny + # protocol: udp + # sequence: 20 + # source: + # any: true + # name: ACL1v4 + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ahp + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # name: ACL2v4 + # afi: ipv4 + # + # commands: + # - no ip access-list ACL1v4 + # - no ip access-list ACL2v4 + # - no ipv6 access-list ACL1v6 + # + # after: + # - acls: + # - aces: + # - destination: + # prefix: 2001:db8:3000::/36 + # grant: deny + # protocol: ipv6 + # sequence: 10 + # source: + # any: true + # - destination: + # host: 2001:db8:2000:ab::2 + # grant: permit + # protocol: tcp + # sequence: 20 + # source: + # host: 2001:db8:2000:2::2 + # name: ACL2v6 + # afi: ipv6 # After state: # ------------ + # nxos-9k# show running-config | section '^ip(v6)* access-list' # ipv6 access-list ACL2v6 # 10 deny ipv6 any 2001:db8:3000::/36 # 20 permit tcp 2001:db8:2000:2::2/128 2001:db8:2000:ab::2/128 @@ -3347,7 +3822,9 @@ Examples 10 permit sctp any any state: parsed - # returns: + # Task Output + # ------------ + # # parsed: # - afi: ipv4 # acls: @@ -3385,7 +3862,7 @@ Examples # Before state: # ------------ - # + # nxos-9k# show running-config | section '^ip(v6)* access-list' # ip access-list ACL1v4 # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin # ipv6 access-list ACL1v6 @@ -3395,7 +3872,9 @@ Examples cisco.nxos.nxos_acls: state: gathered - # returns: + # Task Output + # ----------- + # # gathered: # - afi: ipv4 # acls: @@ -3466,7 +3945,9 @@ Examples protocol: sctp state: rendered - # returns: + # Task Output + # ----------- + # # rendered: # ip access-list ACL1v4 # 50 deny tcp any lt 55 192.0.2.64 0.0.0.255 ack fin @@ -3540,6 +4021,57 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['ip access-list ACL1v4', '10 permit ip any any precedence critical log', '20 deny tcp any lt smtp host 192.0.2.64 ack fin']</div> </td> </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>gathered</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>gathered</code></td> + <td> + <div>Facts about the network resource gathered from the remote device as structured data.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>parsed</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>parsed</code></td> + <td> + <div>The device native config provided in <em>running_config</em> option parsed into structured data as per module argspec.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>rendered</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>rendered</code></td> + <td> + <div>The provided configuration in the task rendered in device-native format (offline).</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['ip access-list ACL1v4', '10 permit ip any any precedence critical log', '20 deny tcp any lt smtp host 192.0.2.64 ack fin']</div> + </td> + </tr> </table> <br/><br/> diff --git a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_address_family_module.rst b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_address_family_module.rst index 10444549a..8378c8439 100644 --- a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_address_family_module.rst +++ b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_address_family_module.rst @@ -1690,8 +1690,8 @@ Examples id: 101 route_map: rmap-eigrp-1 - # Task output - # ------------- + # Task output: + # ------------ # before: {} # # commands: @@ -1744,7 +1744,7 @@ Examples # route_map: rmap-eigrp-1 # After state: - # ------------- + # ------------ # Nexus9000v# show running-config | section "^router bgp" # router bgp 65536 # address-family ipv4 multicast @@ -1804,8 +1804,8 @@ Examples vrf: site-1 state: replaced - # Task output - # ------------- + # Task output: + # ------------ # before: # as_number: "65536" # address_family: @@ -1884,7 +1884,7 @@ Examples # route_map: rmap-eigrp-1 # After state: - # ------------- + # ------------ # Nexus9000v# show running-config | section "^router bgp" # router bgp 65536 # address-family ipv4 multicast @@ -1936,8 +1936,8 @@ Examples vrf: site-1 state: overridden - # Task output - # ------------- + # Task output: + # ------------ # before: # as_number: "65536" # address_family: @@ -2005,7 +2005,7 @@ Examples # # After state: - # ------------- + # ------------ # Nexus9000v# show running-config | section "^router bgp" # router bgp 65536 # address-family ipv4 multicast @@ -2046,8 +2046,8 @@ Examples safi: multicast state: deleted - # Task output - # ------------- + # Task output: + # ------------ # before: # as_number: "65536" # address_family: @@ -2102,7 +2102,7 @@ Examples # summary_only: True # After state: - # ------------- + # ------------ # Nexus9000v# show running-config | section "^router bgp" # router bgp 65536 # vrf site-1 @@ -2133,8 +2133,8 @@ Examples cisco.nxos.nxos_bgp_address_family: state: deleted - # Task output - # ------------- + # Task output: + # ------------ # before: # as_number: "65536" # address_family: @@ -2180,7 +2180,7 @@ Examples # as_number: "65536" # After state: - # ------------- + # ------------ # Nexus9000v# show running-config | section "^router bgp" # router bgp 65536 # Nexus9000v# @@ -2224,8 +2224,8 @@ Examples route_map: rmap-eigrp-1 state: rendered - # Task Output (redacted) - # ----------------------- + # Task Output: + # ------------ # rendered: # - router bgp 65536 # - address-family ipv4 multicast @@ -2264,8 +2264,8 @@ Examples running_config: "{{ lookup('file', 'parsed.cfg') }}" state: parsed - # Task output (redacted) - # ----------------------- + # Task output: + # ------------ # parsed: # as_number: "65536" # address_family: @@ -2302,6 +2302,123 @@ Examples +Return Values +------------- +Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>after</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td>when changed</td> + <td> + <div>The resulting configuration after module execution.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>before</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td>when <em>state</em> is <code>merged</code>, <code>replaced</code>, <code>overridden</code>, <code>deleted</code> or <code>purged</code></td> + <td> + <div>The configuration prior to the module execution.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>commands</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>merged</code>, <code>replaced</code>, <code>overridden</code>, <code>deleted</code> or <code>purged</code></td> + <td> + <div>The set of commands pushed to the remote device.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['router bgp 65536', 'address-family ipv4 multicast', 'nexthop route-map rmap2']</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>gathered</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td>when <em>state</em> is <code>gathered</code></td> + <td> + <div>Facts about the network resource gathered from the remote device as structured data.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>parsed</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td>when <em>state</em> is <code>parsed</code></td> + <td> + <div>The device native config provided in <em>running_config</em> option parsed into structured data as per module argspec.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>rendered</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>rendered</code></td> + <td> + <div>The provided configuration in the task rendered in device-native format (offline).</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['router bgp 65536', 'address-family ipv4 multicast', 'nexthop route-map rmap2']</div> + </td> + </tr> + </table> + <br/><br/> + Status ------ diff --git a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_af_module.rst b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_af_module.rst deleted file mode 100644 index 98b99d7e9..000000000 --- a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_af_module.rst +++ /dev/null @@ -1,677 +0,0 @@ -.. _cisco.nxos.nxos_bgp_af_module: - - -********************** -cisco.nxos.nxos_bgp_af -********************** - -**(deprecated, removed after 2023-02-24) Manages BGP Address-family configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2023-02-24 -:Why: Updated module released with more functionality. -:Alternative: nxos_bgp_address_family - - - -Synopsis --------- -- Manages BGP Address-family configurations on NX-OS switches. - - - - -Parameters ----------- - -.. raw:: html - - <table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>additional_paths_install</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Install a backup path into the forwarding table and provide prefix independent convergence (PIC) in case of a PE-CE link failure.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>additional_paths_receive</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enables the receive capability of additional paths for all of the neighbors under this address family for which the capability has not been disabled.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>additional_paths_selection</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Configures the capability of selecting additional paths for a prefix. Valid values are a string defining the name of the route-map.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>additional_paths_send</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enables the send capability of additional paths for all of the neighbors under this address family for which the capability has not been disabled.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>advertise_l2vpn_evpn</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Advertise evpn routes.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>afi</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>ipv4</li> - <li>ipv6</li> - <li>vpnv4</li> - <li>vpnv6</li> - <li>l2vpn</li> - </ul> - </td> - <td> - <div>Address Family Identifier.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>asn</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> - </div> - </td> - <td> - </td> - <td> - <div>BGP autonomous system number. Valid values are String, Integer in ASPLAIN or ASDOT notation.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>client_to_client</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Configure client-to-client route reflection.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>dampen_igp_metric</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify dampen value for IGP metric-related changes, in seconds. Valid values are integer and keyword 'default'.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>dampening_half_time</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify decay half-life in minutes for route-flap dampening. Valid values are integer and keyword 'default'.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>dampening_max_suppress_time</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify max suppress time for route-flap dampening stable route. Valid values are integer and keyword 'default'.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>dampening_reuse_time</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify route reuse time for route-flap dampening. Valid values are integer and keyword 'default'.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>dampening_routemap</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify route-map for route-flap dampening. Valid values are a string defining the name of the route-map.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>dampening_state</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enable/disable route-flap dampening.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>dampening_suppress_time</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify route suppress time for route-flap dampening. Valid values are integer and keyword 'default'.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>default_information_originate</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Default information originate.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>default_metric</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Sets default metrics for routes redistributed into BGP. Valid values are Integer or keyword 'default'</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>distance_ebgp</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Sets the administrative distance for eBGP routes. Valid values are Integer or keyword 'default'.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>distance_ibgp</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Sets the administrative distance for iBGP routes. Valid values are Integer or keyword 'default'.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>distance_local</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Sets the administrative distance for local BGP routes. Valid values are Integer or keyword 'default'.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>inject_map</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=list</span> - </div> - </td> - <td> - </td> - <td> - <div>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']].</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>maximum_paths</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Configures the maximum number of equal-cost paths for load sharing. Valid value is an integer in the range 1-64.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>maximum_paths_ibgp</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Configures the maximum number of ibgp equal-cost paths for load sharing. Valid value is an integer in the range 1-64.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>networks</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=list</span> - </div> - </td> - <td> - </td> - <td> - <div>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']].</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>next_hop_route_map</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Configure a route-map for valid nexthops. Valid values are a string defining the name of the route-map.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>redistribute</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=list</span> - </div> - </td> - <td> - </td> - <td> - <div>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']].</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>retain_route_target</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - <div style="font-style: italic; font-size: small; color: darkgreen">added in 1.1.0</div> - </td> - <td> - </td> - <td> - <div>Retains all of the routes or the routes which are part of configured route-map. Valid values are route-map names or keyword <code>all</code> or keyword <code>default</code>. <code>all</code> retains all the routes regardless of Target-VPN community. <code>default</code> will disable the retain route target option. If you are using route-map name please ensure that the name is not same as <code>all</code> and <code>default</code>.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>safi</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>unicast</li> - <li>multicast</li> - <li>evpn</li> - </ul> - </td> - <td> - <div>Sub Address Family Identifier.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>state</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>present</b> ←</div></li> - <li>absent</li> - </ul> - </td> - <td> - <div>Determines whether the config should be present or not on the device.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>suppress_inactive</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Advertises only active routes to peers.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>table_map</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Apply table-map to filter routes downloaded into URIB. Valid values are a string.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>table_map_filter</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Filters routes rejected by the route-map and does not download them to the RIB.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>vrf</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"default"</div> - </td> - <td> - <div>Name of the VRF. The name 'default' is a valid VRF representing the global bgp.</div> - </td> - </tr> - </table> - <br/> - - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - ``state=absent`` removes the whole BGP ASN configuration - - Default, where supported, restores params default value. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_. - - - -Examples --------- - -.. code-block:: yaml - - # configure a simple address-family - - cisco.nxos.nxos_bgp_af: - asn: 65535 - vrf: TESTING - afi: ipv4 - safi: unicast - advertise_l2vpn_evpn: true - state: present - retain_route_target: all - - - -Return Values -------------- -Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module: - -.. raw:: html - - <table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Key</th> - <th>Returned</th> - <th width="100%">Description</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="return-"></div> - <b>commands</b> - <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - </div> - </td> - <td>always</td> - <td> - <div>commands sent to the device</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['router bgp 65535', 'vrf TESTING', 'address-family ipv4 unicast', 'advertise l2vpn evpn', 'retain route-target all']</div> - </td> - </tr> - </table> - <br/><br/> - - -Status ------- - - -- This module will be removed in a release after 2023-02-24. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_global_module.rst b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_global_module.rst index a658b46ad..1ef0c27b4 100644 --- a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_global_module.rst +++ b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_global_module.rst @@ -1892,6 +1892,23 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="5"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>remote_as_route_map</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Route-map to match prefix peer AS number.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>remove_private_as</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -4008,6 +4025,24 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="4"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>remote_as_route_map</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Route-map to match prefix peer AS number.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>remove_private_as</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -4544,6 +4579,7 @@ Parameters <ul style="margin: 0; padding: 0"><b>Choices:</b> <li><div style="color: blue"><b>merged</b> ←</div></li> <li>replaced</li> + <li>overridden</li> <li>deleted</li> <li>purged</li> <li>parsed</li> @@ -4556,7 +4592,8 @@ Parameters <div>State <em>purged</em> removes all the BGP configurations from the target device. Use caution with this state.</div> <div>State <em>deleted</em> only removes BGP attributes that this modules manages and does not negate the BGP process completely. Thereby, preserving address-family related configurations under BGP context.</div> <div>Running states <em>deleted</em> and <em>replaced</em> will result in an error if there are address-family configuration lines present under a neighbor, or a vrf context that is to be removed. Please use the <span class='module'>cisco.nxos.nxos_bgp_af</span> or <span class='module'>cisco.nxos.nxos_bgp_neighbor_af</span> modules for prior cleanup.</div> - <div>States <em>merged</em> and <em>replaced</em> will result in a failure if BGP is already configured with a different ASN than what is provided in the task. In such cases, please use state <em>purged</em> to remove the existing BGP process and proceed further.</div> + <div>States <code>merged</code> and <code>replaced</code> will result in a failure if BGP is already configured with a different ASN than what is provided in the task. In such cases, please use state <code>purged</code> to remove the existing BGP process and proceed further.</div> + <div>States <code>replaced</code> and <code>overridden</code> have the same behaviour for this module.</div> <div>Refer to examples for more details.</div> </td> </tr> @@ -4648,8 +4685,8 @@ Examples neighbor_down: fib_accelerate: True - # Task output - # ------------- + # Task output: + # ------------ # before: {} # # commands: @@ -4754,7 +4791,7 @@ Examples # After state: - # ------------- + # ------------ # Nexus9000v# show running-config | section "^router bgp" # router bgp 65563 # router-id 192.168.1.1 @@ -4878,8 +4915,8 @@ Examples fib_accelerate: True state: replaced - # Task output - # ------------- + # Task output: + # ------------ # before: # as_number: '65563' # bestpath: @@ -4992,7 +5029,7 @@ Examples # vrf: site-2 # # After state: - # ------------- + # ------------ # Nexus9000v# show running-config | section "^router bgp" # router bgp 65563 # router-id 192.168.1.1 @@ -5073,8 +5110,8 @@ Examples cisco.nxos.nxos_bgp_global: state: deleted - # Task output - # ------------- + # Task output: + # ------------ # before: # as_number: '65563' @@ -5156,7 +5193,7 @@ Examples # as_number: '65563' # # After state: - # ------------- + # ------------ # Nexus9000v# show running-config | section "^router bgp" # router bgp 65563 # address-family ipv4 unicast @@ -5226,8 +5263,8 @@ Examples cisco.nxos.nxos_bgp_global: state: purged - # Task output - # ------------- + # Task output: + # ------------ # before: # as_number: '65563' @@ -5295,7 +5332,7 @@ Examples # after: {} # # After state: - # ------------- + # ------------ # Nexus9000v# show running-config | section "^router bgp" # Nexus9000v# @@ -5363,8 +5400,8 @@ Examples neighbor_down: fib_accelerate: True - # Task Output (redacted) - # ----------------------- + # Task output: + # ------------ # rendered: # - router bgp 65563 # - bestpath as-path multipath-relax @@ -5453,8 +5490,8 @@ Examples running_config: "{{ lookup('file', 'parsed.cfg') }}" state: parsed - # Task output (redacted) - # ----------------------- + # Task output: + # ------------ # parsed: # as_number: '65563' # bestpath: @@ -5546,8 +5583,8 @@ Examples cisco.nxos.nxos_bgp_global: state: gathered - # Task output (redacted) - # ----------------------- + # Task output: + # ------------ # gathered: # as_number: '65563' # bestpath: @@ -5620,8 +5657,8 @@ Examples key: 12090404011C03162E state: replaced - # Task output (redacted) - # ----------------------- + # Task output: + # ------------ # fatal: [Nexus9000v]: FAILED! => changed=false # msg: Neighbor 203.0.113.2 has address-family configurations. # Please use the nxos_bgp_neighbor_af module to remove those first. @@ -5668,8 +5705,8 @@ Examples fib_accelerate: True state: replaced - # Task output (redacted) - # ----------------------- + # Task output: + # ------------ # fatal: [Nexus9000v]: FAILED! => changed=false # msg: VRF site-1 has address-family configurations. # Please use the nxos_bgp_af module to remove those first. @@ -5741,6 +5778,57 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['router bgp 65563', 'maxas-limit 20', 'router-id 192.168.1.1', 'confederation peers 65020 65030 65040', 'neighbor 192.168.1.100', 'remote-as 65563', 'affinity-group 160', 'bmp-activate-server 1', 'description NBR-1', 'low-memory exempt', 'vrf site-1', 'log-neighbor-changes', 'neighbor 198.51.100.1', 'remote-as 65562', 'description site-1-nbr-1', 'password 3 13D4D3549493D2877B1DC116EE27A6BE']</div> </td> </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>gathered</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td>when <em>state</em> is <code>gathered</code></td> + <td> + <div>Facts about the network resource gathered from the remote device as structured data.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>parsed</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td>when <em>state</em> is <code>parsed</code></td> + <td> + <div>The device native config provided in <em>running_config</em> option parsed into structured data as per module argspec.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>rendered</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>rendered</code></td> + <td> + <div>The provided configuration in the task rendered in device-native format (offline).</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['router bgp 65563', 'maxas-limit 20', 'router-id 192.168.1.1']</div> + </td> + </tr> </table> <br/><br/> diff --git a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_module.rst b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_module.rst deleted file mode 100644 index e31ad1d85..000000000 --- a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_module.rst +++ /dev/null @@ -1,840 +0,0 @@ -.. _cisco.nxos.nxos_bgp_module: - - -******************* -cisco.nxos.nxos_bgp -******************* - -**(deprecated, removed after 2023-01-27) Manages BGP configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2023-01-27 -:Why: Updated module released with more functionality. -:Alternative: nxos_bgp_global - - - -Synopsis --------- -- Manages BGP configurations on NX-OS switches. - - - - -Parameters ----------- - -.. raw:: html - - <table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>asn</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> - </div> - </td> - <td> - </td> - <td> - <div>BGP autonomous system number. Valid values are String, Integer in ASPLAIN or ASDOT notation.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>bestpath_always_compare_med</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enable/Disable MED comparison on paths from different autonomous systems.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>bestpath_aspath_multipath_relax</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enable/Disable load sharing across the providers with different (but equal-length) AS paths.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>bestpath_compare_neighborid</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enable/Disable neighborid. Use this when more paths available than max path config.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>bestpath_compare_routerid</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enable/Disable comparison of router IDs for identical eBGP paths.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>bestpath_cost_community_ignore</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enable/Disable Ignores the cost community for BGP best-path calculations.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>bestpath_med_confed</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enable/Disable enforcement of bestpath to do a MED comparison only between paths originated within a confederation.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>bestpath_med_missing_as_worst</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enable/Disable assigns the value of infinity to received routes that do not carry the MED attribute, making these routes the least desirable.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>bestpath_med_non_deterministic</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enable/Disable deterministic selection of the best MED pat from among the paths from the same autonomous system.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>cluster_id</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Route Reflector Cluster-ID.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>confederation_id</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Routing domain confederation AS.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>confederation_peers</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> - </div> - </td> - <td> - </td> - <td> - <div>AS confederation parameters.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>disable_policy_batching</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enable/Disable the batching evaluation of prefix advertisement to all peers.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>disable_policy_batching_ipv4_prefix_list</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Enable/Disable the batching evaluation of prefix advertisements to all peers with prefix list.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>disable_policy_batching_ipv6_prefix_list</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Enable/Disable the batching evaluation of prefix advertisements to all peers with prefix list.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>enforce_first_as</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>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.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>event_history_cli</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>size_small</li> - <li>size_medium</li> - <li>size_large</li> - <li>size_disable</li> - <li>default</li> - <li>true</li> - <li>false</li> - </ul> - </td> - <td> - <div>Enable/Disable cli event history buffer.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>event_history_detail</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>size_small</li> - <li>size_medium</li> - <li>size_large</li> - <li>size_disable</li> - <li>default</li> - <li>true</li> - <li>false</li> - </ul> - </td> - <td> - <div>Enable/Disable detail event history buffer.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>event_history_events</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>size_small</li> - <li>size_medium</li> - <li>size_large</li> - <li>size_disable</li> - <li>default</li> - <li>true</li> - <li>false</li> - </ul> - </td> - <td> - <div>Enable/Disable event history buffer.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>event_history_periodic</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>size_small</li> - <li>size_medium</li> - <li>size_large</li> - <li>size_disable</li> - <li>default</li> - <li>true</li> - <li>false</li> - </ul> - </td> - <td> - <div>Enable/Disable periodic event history buffer.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>fast_external_fallover</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enable/Disable immediately reset the session if the link to a directly connected BGP peer goes down. Only supported in the global BGP context.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>flush_routes</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enable/Disable flush routes in RIB upon controlled restart. On NX-OS, this property is only supported in the global BGP context.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>graceful_restart</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enable/Disable graceful restart.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>graceful_restart_helper</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enable/Disable graceful restart helper mode.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>graceful_restart_timers_restart</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set maximum time for a restart sent to the BGP peer.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>graceful_restart_timers_stalepath_time</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set maximum time that BGP keeps the stale routes from the restarting BGP peer.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>isolate</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enable/Disable isolate this router from BGP perspective.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>local_as</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Local AS number to be used within a VRF instance.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>log_neighbor_changes</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enable/Disable message logging for neighbor up/down event.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>maxas_limit</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify Maximum number of AS numbers allowed in the AS-path attribute. Valid values are between 1 and 512.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>neighbor_down_fib_accelerate</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enable/Disable handle BGP neighbor down event, due to various reasons.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>reconnect_interval</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>The BGP reconnection interval for dropped sessions. Valid values are between 1 and 60.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>router_id</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Router Identifier (ID) of the BGP router VRF instance.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>shutdown</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Administratively shutdown the BGP protocol.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>state</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>present</b> ←</div></li> - <li>absent</li> - </ul> - </td> - <td> - <div>Determines whether the config should be present or not on the device.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>suppress_fib_pending</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enable/Disable advertise only routes programmed in hardware to peers.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>timer_bestpath_limit</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify timeout for the first best path after a restart, in seconds.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>timer_bgp_hold</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set BGP hold timer.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>timer_bgp_keepalive</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set BGP keepalive timer.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>vrf</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"default"</div> - </td> - <td> - <div>Name of the VRF. The name 'default' is a valid VRF representing the global BGP.</div> - </td> - </tr> - </table> - <br/> - - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - ``state=absent`` removes the whole BGP ASN configuration when ``vrf=default`` or the whole VRF instance within the BGP process when using a different VRF. - - Default when supported restores params default value. - - Configuring global params is only permitted if ``vrf=default``. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_. - - - -Examples --------- - -.. code-block:: yaml - - - name: Configure a simple ASN - cisco.nxos.nxos_bgp: - asn: 65535 - vrf: test - router_id: 192.0.2.1 - state: present - - - -Return Values -------------- -Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module: - -.. raw:: html - - <table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Key</th> - <th>Returned</th> - <th width="100%">Description</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="return-"></div> - <b>commands</b> - <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - </div> - </td> - <td>always</td> - <td> - <div>commands sent to the device</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['router bgp 65535', 'vrf test', 'router-id 192.0.2.1']</div> - </td> - </tr> - </table> - <br/><br/> - - -Status ------- - - -- This module will be removed in a release after 2023-01-27. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Jason Edelman (@jedelman8) -- Gabriele Gerbino (@GGabriele) diff --git a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst index 0473c5d76..96e3c5e53 100644 --- a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst +++ b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_neighbor_address_family_module.rst @@ -859,6 +859,28 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="4"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>rewrite_rt_asn</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Auto generate RTs for EBGP neighbor.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>route_map</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -2080,6 +2102,29 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>rewrite_rt_asn</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Auto generate RTs for EBGP neighbor.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>route_map</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -2599,8 +2644,8 @@ Examples send_community: set: True - # Task output - # ------------- + # Task output: + # ------------ # before: {} # # commands: @@ -2668,7 +2713,7 @@ Examples # safi: unicast # After state: - # ------------- + # ------------ # Nexus9000v# show running-config | section "^router bgp" # router bgp 65536 # neighbor 192.0.2.32 @@ -2755,8 +2800,8 @@ Examples set: True state: replaced - # Task output - # ------------- + # Task output: + # ------------ # before: # as_number: "65536" # neighbors: @@ -2847,7 +2892,7 @@ Examples # safi: unicast # After state: - # ------------- + # ------------ # Nexus9000v# show running-config | section "^router bgp" # router bgp 65536 # neighbor 192.0.2.32 @@ -2914,8 +2959,8 @@ Examples set: True state: overridden - # Task output - # ------------- + # Task output: + # ------------ # before: # as_number: "65536" # neighbors: @@ -2993,7 +3038,7 @@ Examples # set: True # After state: - # ------------- + # ------------ # Nexus9000v# show running-config | section "^router bgp" # router bgp 65536 # neighbor 192.0.2.32 @@ -3049,8 +3094,8 @@ Examples safi: unicast state: deleted - # Task output - # ------------- + # Task output: + # ------------ # before: # as_number: "65536" # neighbors: @@ -3133,7 +3178,7 @@ Examples # set: True # # After state: - # ------------- + # ------------ # Nexus9000v# show running-config | section "^router bgp" # router bgp 65536 # neighbor 192.0.2.32 @@ -3182,8 +3227,8 @@ Examples cisco.nxos.nxos_bgp_neighbor_address_family: state: deleted - # Task output - # ------------- + # Task output: + # ------------ # before: # as_number: "65536" # neighbors: @@ -3244,7 +3289,7 @@ Examples # as_number: "65536" # # After state: - # ------------- + # ------------ # Nexus9000v# show running-config | section "^router bgp" # router bgp 65536 # neighbor 192.0.2.32 @@ -3301,8 +3346,8 @@ Examples set: True state: rendered - # Task Output (redacted) - # ----------------------- + # Task output: + # ------------ # rendered: # - router bgp 65536 # - neighbor 192.0.2.32 @@ -3356,8 +3401,8 @@ Examples running_config: "{{ lookup('file', 'parsed.cfg') }}" state: parsed - # Task output (redacted) - # ----------------------- + # Task output: + # ------------ # parsed: # as_number: "65536" # neighbors: @@ -3402,6 +3447,123 @@ Examples +Return Values +------------- +Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>after</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td>when changed</td> + <td> + <div>The resulting configuration after module execution.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>before</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td>when <em>state</em> is <code>merged</code>, <code>replaced</code>, <code>overridden</code>, <code>deleted</code> or <code>purged</code></td> + <td> + <div>The configuration prior to the module execution.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>commands</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>merged</code>, <code>replaced</code>, <code>overridden</code>, <code>deleted</code> or <code>purged</code></td> + <td> + <div>The set of commands pushed to the remote device.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['router bgp 65536', 'neighbor 192.0.2.32', 'address-family ipv4 unicast']</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>gathered</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td>when <em>state</em> is <code>gathered</code></td> + <td> + <div>Facts about the network resource gathered from the remote device as structured data.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>parsed</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td>when <em>state</em> is <code>parsed</code></td> + <td> + <div>The device native config provided in <em>running_config</em> option parsed into structured data as per module argspec.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>rendered</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>rendered</code></td> + <td> + <div>The provided configuration in the task rendered in device-native format (offline).</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['router bgp 65536', 'neighbor 192.0.2.32', 'address-family ipv4 unicast']</div> + </td> + </tr> + </table> + <br/><br/> + Status ------ diff --git a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_neighbor_af_module.rst b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_neighbor_af_module.rst deleted file mode 100644 index 00f856531..000000000 --- a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_neighbor_af_module.rst +++ /dev/null @@ -1,749 +0,0 @@ -.. _cisco.nxos.nxos_bgp_neighbor_af_module: - - -******************************* -cisco.nxos.nxos_bgp_neighbor_af -******************************* - -**(deprecated, removed after 2023-02-24) Manages BGP address-family's neighbors configuration.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2023-02-24 -:Why: Updated module released with more functionality. -:Alternative: nxos_bgp_neighbor_address_family - - - -Synopsis --------- -- Manages BGP address-family's neighbors configurations on NX-OS switches. - - - - -Parameters ----------- - -.. raw:: html - - <table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>additional_paths_receive</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>enable</li> - <li>disable</li> - <li>inherit</li> - </ul> - </td> - <td> - <div>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).</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>additional_paths_send</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>enable</li> - <li>disable</li> - <li>inherit</li> - </ul> - </td> - <td> - <div>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).</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>advertise_map_exist</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> - </div> - </td> - <td> - </td> - <td> - <div>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.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>advertise_map_non_exist</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> - </div> - </td> - <td> - </td> - <td> - <div>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.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>afi</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>ipv4</li> - <li>ipv6</li> - <li>vpnv4</li> - <li>vpnv6</li> - <li>l2vpn</li> - </ul> - </td> - <td> - <div>Address Family Identifier.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>allowas_in</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Activate allowas-in property</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>allowas_in_max</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Max-occurrences value for allowas_in. Valid values are an integer value or 'default'. This is mutually exclusive with allowas_in.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>as_override</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Activate the as-override feature.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>asn</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> - </div> - </td> - <td> - </td> - <td> - <div>BGP autonomous system number. Valid values are String, Integer in ASPLAIN or ASDOT notation.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>default_originate</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Activate the default-originate feature.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>default_originate_route_map</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>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.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>disable_peer_as_check</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Disable checking of peer AS-number while advertising</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>filter_list_in</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Valid values are a string defining a filter-list name, or 'default'.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>filter_list_out</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Valid values are a string defining a filter-list name, or 'default'.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>max_prefix_interval</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Optional restart interval. Valid values are an integer. Requires max_prefix_limit. May not be combined with max_prefix_warning.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>max_prefix_limit</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>maximum-prefix limit value. Valid values are an integer value or 'default'.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>max_prefix_threshold</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Optional threshold percentage at which to generate a warning. Valid values are an integer value. Requires max_prefix_limit.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>max_prefix_warning</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Optional warning-only keyword. Requires max_prefix_limit. May not be combined with max_prefix_interval.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>neighbor</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> - </div> - </td> - <td> - </td> - <td> - <div>Neighbor Identifier. Valid values are string. Neighbors may use IPv4 or IPv6 notation, with or without prefix length.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>next_hop_self</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Activate the next-hop-self feature.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>next_hop_third_party</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Activate the next-hop-third-party feature.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>prefix_list_in</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Valid values are a string defining a prefix-list name, or 'default'.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>prefix_list_out</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Valid values are a string defining a prefix-list name, or 'default'.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>rewrite_evpn_rt_asn</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - <div style="font-style: italic; font-size: small; color: darkgreen">added in 1.1.0</div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Auto generate route targets for EBGP neighbor.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>route_map_in</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Valid values are a string defining a route-map name, or 'default'.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>route_map_out</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Valid values are a string defining a route-map name, or 'default'.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>route_reflector_client</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Router reflector client.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>safi</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>unicast</li> - <li>multicast</li> - <li>evpn</li> - </ul> - </td> - <td> - <div>Sub Address Family Identifier.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>send_community</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>none</li> - <li>both</li> - <li>extended</li> - <li>standard</li> - <li>default</li> - </ul> - </td> - <td> - <div>send-community attribute.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>soft_reconfiguration_in</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>enable</li> - <li>always</li> - <li>inherit</li> - </ul> - </td> - <td> - <div>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).</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>soo</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Site-of-origin. Valid values are a string defining a VPN extcommunity or 'default'.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>state</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>present</b> ←</div></li> - <li>absent</li> - </ul> - </td> - <td> - <div>Determines whether the config should be present or not on the device.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>suppress_inactive</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>suppress-inactive feature.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>unsuppress_map</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>unsuppress-map. Valid values are a string defining a route-map name or 'default'.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>vrf</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"default"</div> - </td> - <td> - <div>Name of the VRF. The name 'default' is a valid VRF representing the global bgp.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>weight</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Weight value. Valid values are an integer value or 'default'.</div> - </td> - </tr> - </table> - <br/> - - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - ``state=absent`` removes the whole BGP address-family's neighbor configuration. - - Default, when supported, removes properties - - In order to default maximum-prefix configuration, only ``max_prefix_limit=default`` is needed. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_. - - - -Examples --------- - -.. code-block:: yaml - - - name: configure RR client - cisco.nxos.nxos_bgp_neighbor_af: - asn: 65535 - neighbor: 192.0.2.3 - afi: ipv4 - safi: unicast - route_reflector_client: true - state: present - rewrite_evpn_rt_asn: true - - - -Return Values -------------- -Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module: - -.. raw:: html - - <table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Key</th> - <th>Returned</th> - <th width="100%">Description</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="return-"></div> - <b>commands</b> - <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - </div> - </td> - <td>always</td> - <td> - <div>commands sent to the device</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['router bgp 65535', 'neighbor 192.0.2.3', 'address-family ipv4 unicast', 'route-reflector-client', 'rewrite-evpn-rt-asn']</div> - </td> - </tr> - </table> - <br/><br/> - - -Status ------- - - -- This module will be removed in a release after 2023-02-24. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_neighbor_module.rst b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_neighbor_module.rst deleted file mode 100644 index e6f9e8f57..000000000 --- a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_neighbor_module.rst +++ /dev/null @@ -1,561 +0,0 @@ -.. _cisco.nxos.nxos_bgp_neighbor_module: - - -**************************** -cisco.nxos.nxos_bgp_neighbor -**************************** - -**(deprecated, removed after 2023-01-27) Manages BGP neighbors configurations.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2023-01-27 -:Why: Updated module released with more functionality. -:Alternative: nxos_bgp_global - - - -Synopsis --------- -- Manages BGP neighbors configurations on NX-OS switches. - - - - -Parameters ----------- - -.. raw:: html - - <table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>asn</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> - </div> - </td> - <td> - </td> - <td> - <div>BGP autonomous system number. Valid values are string, Integer in ASPLAIN or ASDOT notation.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>bfd</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>enable</li> - <li>disable</li> - </ul> - </td> - <td> - <div>Enables/Disables BFD for a given neighbor.</div> - <div>Dependency: ''feature bfd''</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>capability_negotiation</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Configure whether or not to negotiate capability with this neighbor.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>connected_check</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Configure whether or not to check for directly connected peer.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>description</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Description of the neighbor.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>dynamic_capability</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Configure whether or not to enable dynamic capability.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>ebgp_multihop</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify multihop TTL for a remote peer. Valid values are integers between 2 and 255, or keyword 'default' to disable this property.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>local_as</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>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.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>log_neighbor_changes</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>enable</li> - <li>disable</li> - <li>inherit</li> - </ul> - </td> - <td> - <div>Specify whether or not to enable log messages for neighbor up/down event.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>low_memory_exempt</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Specify whether or not to shut down this neighbor under memory pressure.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>maximum_peers</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>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.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>neighbor</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> - </div> - </td> - <td> - </td> - <td> - <div>Neighbor Identifier. Valid values are string. Neighbors may use IPv4 or IPv6 notation, with or without prefix length.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>peer_type</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - <div style="font-style: italic; font-size: small; color: darkgreen">added in 1.1.0</div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>fabric_border_leaf</li> - <li>fabric_external</li> - <li>disable</li> - </ul> - </td> - <td> - <div>Specify the peer type for BGP session.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>pwd</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify the password for neighbor. Valid value is string.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>pwd_type</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>3des</li> - <li>cisco_type_7</li> - <li>default</li> - </ul> - </td> - <td> - <div>Specify the encryption type the password will use. Valid values are '3des' or 'cisco_type_7' encryption or keyword 'default'.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>remote_as</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>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.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>remove_private_as</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>enable</li> - <li>disable</li> - <li>all</li> - <li>replace-as</li> - </ul> - </td> - <td> - <div>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.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>shutdown</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Configure to administratively shutdown this neighbor.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>state</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>present</b> ←</div></li> - <li>absent</li> - </ul> - </td> - <td> - <div>Determines whether the config should be present or not on the device.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>suppress_4_byte_as</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Configure to suppress 4-byte AS Capability.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>timers_holdtime</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify holdtime timer value. Valid values are integers between 0 and 3600 in terms of seconds, or 'default', which is 180.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>timers_keepalive</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify keepalive timer value. Valid values are integers between 0 and 3600 in terms of seconds, or 'default', which is 60.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>transport_passive_only</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>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.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>update_source</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify source interface of BGP session and updates.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>vrf</b> - <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"default"</div> - </td> - <td> - <div>Name of the VRF. The name 'default' is a valid VRF representing the global bgp.</div> - </td> - </tr> - </table> - <br/> - - -Notes ------ - -.. note:: - - Tested against NXOSv 7.3.(0)D1(1) on VIRL - - Unsupported for Cisco MDS - - ``state=absent`` removes the whole BGP neighbor configuration. - - Default, where supported, restores params default value. - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_. - - - -Examples --------- - -.. code-block:: yaml - - # create a new neighbor - - cisco.nxos.nxos_bgp_neighbor: - asn: 65535 - neighbor: 192.0.2.3 - local_as: 20 - remote_as: 30 - bfd: enable - description: just a description - update_source: Ethernet1/3 - state: present - peer_type: fabric_external - - - -Return Values -------------- -Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module: - -.. raw:: html - - <table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Key</th> - <th>Returned</th> - <th width="100%">Description</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="return-"></div> - <b>commands</b> - <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - </div> - </td> - <td>always</td> - <td> - <div>commands sent to the device</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['router bgp 65535', 'neighbor 192.0.2.3', 'remote-as 30', 'update-source Ethernet1/3', 'description just a description', 'local-as 20', 'peer-type fabric-external']</div> - </td> - </tr> - </table> - <br/><br/> - - -Status ------- - - -- This module will be removed in a release after 2023-01-27. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Gabriele Gerbino (@GGabriele) diff --git a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_templates_module.rst b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_templates_module.rst new file mode 100644 index 000000000..9287d7a60 --- /dev/null +++ b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_bgp_templates_module.rst @@ -0,0 +1,2841 @@ +.. _cisco.nxos.nxos_bgp_templates_module: + + +***************************** +cisco.nxos.nxos_bgp_templates +***************************** + +**BGP Templates resource module.** + + +Version added: 4.2.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages BGP templates on devices running Cisco NX-OS. + + + + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="6">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="6"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>config</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A list of BGP templates.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>as_number</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Autonomous System Number of the router.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>neighbor</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + / <span style="color: purple">elements=dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Configure BGP peer templates.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>address_family</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + / <span style="color: purple">elements=dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Configure an address-family for peer.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>advertise_map</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Specify route-map for conditional advertisement.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>exist_map</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Condition route-map to advertise only when prefix in condition exists.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>non_exist_map</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Condition route-map to advertise only when prefix in condition does not exist.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>route_map</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> + </div> + </td> + <td> + </td> + <td> + <div>Route-map name.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>advertisement_interval</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Minimum interval between sending BGP routing updates.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>afi</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>ipv4</li> + <li>ipv6</li> + <li>link-state</li> + <li>l2vpn</li> + </ul> + </td> + <td> + <div>Address Family indicator.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>allowas_in</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Accept as-path with my AS present in it.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>max_occurences</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Number of occurrences of AS number, default is 3.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>set</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Activate allowas-in property.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>as_override</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Override matching AS-number while sending update.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>capability</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Advertise capability to the peer.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>additional_paths</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Additional paths capability.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>receive</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Additional paths Receive capability.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>send</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>enable</li> + <li>disable</li> + </ul> + </td> + <td> + <div>Additional paths Send capability.</div> + </td> + </tr> + + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>default_originate</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Originate a default toward this peer.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>route_map</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Route-map to specify criteria for originating default.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>set</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Set default-originate attribute.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>disable_peer_as_check</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Disable checking of peer AS-number while advertising.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>filter_list</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Name of filter-list.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>inbound</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Apply policy to incoming routes.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>outbound</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Apply policy to outgoing routes.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>inherit</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Inherit a peer-policy template.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>peer_policy</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Peer-policy template to inherit.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>maximum_prefix</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Maximum number of prefixes from this neighbor.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>generate_warning_threshold</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Threshold percentage at which to generate a warning.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>max_prefix_limit</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Maximum prefix limit.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>restart_interval</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Restart bgp connection after limit is exceeded.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>warning_only</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Only give a warning message when limit is exceeded.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>next_hop_self</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Set our address as nexthop (non-reflected).</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>all_routes</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Set our address as nexthop for all routes.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>set</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Set next-hop-self attribute.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>next_hop_third_party</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Compute a third-party nexthop if possible.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>prefix_list</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Apply prefix-list.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>inbound</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Apply policy to incoming routes.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>outbound</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Apply policy to outgoing routes.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>route_map</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Apply route-map to neighbor.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>inbound</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Name of policy to apply to incoming routes.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>outbound</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Name of policy to apply to outgoing routes.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>route_reflector_client</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Configure a neighbor as Route reflector client.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>safi</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>unicast</li> + <li>multicast</li> + <li>mvpn</li> + <li>evpn</li> + </ul> + </td> + <td> + <div>Sub Address Family indicator.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>send_community</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>standard</li> + <li>extended</li> + <li>both</li> + </ul> + </td> + <td> + <div>Send Community attribute to this neighbor.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>soft_reconfiguration_inbound</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Soft reconfiguration.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>always</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Always perform inbound soft reconfiguration.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>set</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Set soft-reconfiguration inbound attribute.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>soo</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specify Site-of-origin extcommunity.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>suppress_inactive</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Advertise only active routes to peer.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>unsuppress_map</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Route-map to selectively unsuppress suppressed routes.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>weight</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Set default weight for routes from this neighbor.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>bfd</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Bidirectional Fast Detection for the neighbor.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>multihop</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Multihop session.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>interval</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Configure BFD session interval parameters.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>min_rx_interval</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + / <span style="color: red">required</span> + </div> + </td> + <td> + </td> + <td> + <div>Minimum RX interval.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>multiplier</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + / <span style="color: red">required</span> + </div> + </td> + <td> + </td> + <td> + <div>Detect Multiplier.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>tx_interval</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + / <span style="color: red">required</span> + </div> + </td> + <td> + </td> + <td> + <div>TX interval in milliseconds.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>set</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Set BFD multihop.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>set</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Set BFD for this neighbor.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>singlehop</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Single-hop session.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>bmp_activate_server</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Specify server ID for activating BMP monitoring for the peer.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>capability</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Capability.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>suppress_4_byte_as</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Suppress 4-byte AS Capability.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>description</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Neighbor specific descripion.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>disable_connected_check</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Disable check for directly connected peer.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>dont_capability_negotiate</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Don't negotiate capability with this neighbor.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>dscp</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Set dscp value for tcp transport.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>dynamic_capability</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Dynamic Capability</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>ebgp_multihop</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Specify multihop TTL for remote peer.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>graceful_shutdown</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Graceful-shutdown for this neighbor.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>activate</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Send graceful-shutdown community.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>route_map</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Apply route-map to modify attributes for outbound.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>set</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Set activate.</div> + </td> + </tr> + + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>inherit</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Inherit a template.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>peer_session</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Peer-session template to inherit.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>local_as</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specify the local-as number for the eBGP neighbor.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>log_neighbor_changes</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Log message for neighbor up/down event.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>disable</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Disable logging of neighbor up/down event.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>set</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Set log-neighbor-changes.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>low_memory</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Behaviour in low memory situations.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>exempt</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Do not shutdown this peer when under memory pressure.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>name</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Name of the BGP peer template.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>password</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Configure a password for neighbor.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>encryption</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>0 specifies an UNENCRYPTED neighbor password.</div> + <div>3 specifies an 3DES ENCRYPTED neighbor password will follow.</div> + <div>7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>key</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Authentication password.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>path_attribute</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + / <span style="color: purple">elements=dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>BGP path attribute optional filtering.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>action</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>discard</li> + <li>treat-as-withdraw</li> + </ul> + </td> + <td> + <div>Action.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>range</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Path attribute range.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>end</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Path attribute range end value.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>start</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Path attribute range start value.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>type</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Path attribute type</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>remote_as</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specify Autonomous System Number of the neighbor.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>remove_private_as</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Remove private AS number from outbound updates.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>all</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>All.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>replace_as</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Replace.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>set</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Remove private AS.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>shutdown</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Administratively shutdown this neighbor.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>timers</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Configure keepalive and hold timers.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>holdtime</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Holdtime (seconds).</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>keepalive</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Keepalive interval (seconds).</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>transport</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>BGP transport connection.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>connection_mode</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Specify type of connection.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>passive</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Allow passive connection setup only.</div> + </td> + </tr> + + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>ttl_security</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Enable TTL Security Mechanism.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>hops</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">integer</span> + </div> + </td> + <td> + </td> + <td> + <div>Specify hop count for remote peer.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>update_source</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Specify source of BGP session and updates.</div> + </td> + </tr> + + + <tr> + <td colspan="6"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>running_config</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>This option is used only with state <em>parsed</em>.</div> + <div>The value of this option should be the output received from the NX-OS device by executing the command <b>show running-config bgp | section 'template'</b>.</div> + <div>The state <em>parsed</em> reads the configuration from <code>running_config</code> option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the <em>parsed</em> key within the result.</div> + </td> + </tr> + <tr> + <td colspan="6"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li><div style="color: blue"><b>merged</b> ←</div></li> + <li>replaced</li> + <li>overridden</li> + <li>deleted</li> + <li>parsed</li> + <li>gathered</li> + <li>rendered</li> + </ul> + </td> + <td> + <div>The state the configuration should be left in.</div> + <div>Refer to examples for more details.</div> + </td> + </tr> + </table> + <br/> + + +Notes +----- + +.. note:: + - Tested against NX-OS 9.3.6. + - Unsupported for Cisco MDS + - This module works with connection ``network_cli`` and ``httpapi``. + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # -------------- + # + # nxos9k# show running-config | section "^router bgp" + # nxos9k# + + - name: Merge the provided configuration with the existing running configuration + cisco.nxos.nxos_bgp_templates: + config: + as_number: 65536 + neighbor: + - name: neighbor_tmplt_1 + address_family: + - afi: ipv4 + safi: unicast + advertise_map: + route_map: rmap1 + non_exist_map: nemap1 + advertisement_interval: 60 + disable_peer_as_check: true + bmp_activate_server: 2 + capability: + suppress_4_byte_as: true + description: Test_BGP_PEER_TEMPLATE_1 + local_as: 65536 + remote_as: 65001 + + - name: neighbor_tmplt_2 + description: Test_BGP_PEER_TEMPLATE_2 + address_family: + - afi: ipv4 + safi: multicast + advertise_map: + route_map: rmap1 + exist_map: emap1 + as_override: true + filter_list: + inbound: flist1 + outbound: flist2 + inherit: + peer_session: psession1 + timers: + holdtime: 100 + keepalive: 45 + # Task Output: + # ------------ + # before: {} + # + # commands: + # - router bgp 65536 + # - template peer neighbor_tmplt_1 + # - bmp-activate-server 2 + # - capability suppress 4-byte-as + # - description Test_BGP_PEER_TEMPLATE_1 + # - local-as 65536 + # - remote-as 65001 + # - address-family ipv4 unicast + # - advertise-map rmap1 non-exist-map nemap1 + # - advertisement-interval 60 + # - disable-peer-as-check + # - template peer neighbor_tmplt_2 + # - description Test_BGP_PEER_TEMPLATE_2 + # - inherit peer-session psession1 + # - timers 45 100 + # - address-family ipv4 multicast + # - advertise-map rmap1 exist-map emap1 + # - as-override + # - filter-list flist1 in + # - filter-list flist2 out + # + # after: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # bmp_activate_server: 2 + # capability: + # suppress_4_byte_as: true + # description: Test_BGP_PEER_TEMPLATE_1 + # local_as: "65536" + # remote_as: "65001" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + + # After state: + # -------------- + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # capability suppress 4-byte-as + # bmp-activate-server 2 + # description Test_BGP_PEER_TEMPLATE_1 + # local-as 65536 + # remote-as 65001 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + # Using replaced + + # Before state: + # ------------- + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # capability suppress 4-byte-as + # description Test_BGP_PEER_TEMPLATE_1 + # bmp-activate-server 2 + # local-as 65536 + # remote-as 65001 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + - name: Replace BGP templates configuration with provided configuration + cisco.nxos.nxos_bgp_templates: + config: + as_number: 65536 + neighbor: + - name: neighbor_tmplt_1 + address_family: + - afi: ipv4 + safi: unicast + advertise_map: + route_map: rmap1 + non_exist_map: nemap1 + advertisement_interval: 60 + disable_peer_as_check: true + inherit: + peer_session: psession1 + description: Test_BGP_PEER_TEMPLATE_1 + local_as: 65537 + state: replaced + + # Task output: + # ------------ + # + # before: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # bmp_activate_server: 2 + # capability: + # suppress_4_byte_as: true + # description: Test_BGP_PEER_TEMPLATE_1 + # local_as: "65536" + # remote_as: "65001" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + # + # commands: + # - router bgp 65536 + # - template peer neighbor_tmplt_1 + # - no bmp-activate-server 2 + # - no capability suppress 4-byte-as + # - inherit peer-session psession1 + # - local-as 65537 + # - no remote-as 65001 + # + # after: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # description: Test_BGP_PEER_TEMPLATE_1 + # inherit: + # peer_session: psession1 + # local_as: "65537" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + + # After state: + # ------------ + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # inherit peer-session psession1 + # description Test_BGP_PEER_TEMPLATE_1 + # local-as 65537 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # bmp-activate-server 2 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + # Using overridden + # + # Before state: + # ------------- + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # capability suppress 4-byte-as + # description Test_BGP_PEER_TEMPLATE_1 + # bmp-activate-server 2 + # local-as 65536 + # remote-as 65001 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + - name: Override BGP templates configuration with provided configuration + cisco.nxos.nxos_bgp_templates: + config: + as_number: 65536 + neighbor: + - name: neighbor_tmplt_1 + address_family: + - afi: ipv4 + safi: unicast + advertise_map: + route_map: rmap1 + non_exist_map: nemap1 + advertisement_interval: 60 + disable_peer_as_check: true + inherit: + peer_session: psession1 + description: Test_BGP_PEER_TEMPLATE_1 + local_as: 65537 + state: overridden + + # Task output: + # ------------ + # + # before: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # bmp_activate_server: 2 + # capability: + # suppress_4_byte_as: true + # description: Test_BGP_PEER_TEMPLATE_1 + # local_as: "65536" + # remote_as: "65001" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + # + # commands: + # - router bgp 65536 + # - template peer neighbor_tmplt_1 + # - no bmp-activate-server 2 + # - no capability suppress 4-byte-as + # - inherit peer-session psession1 + # - local-as 65537 + # - no remote-as 65001 + # - no template peer neighbor_tmplt_2 + # + # after: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # description: Test_BGP_PEER_TEMPLATE_1 + # inherit: + # peer_session: psession1 + # local_as: "65537" + + # After state: + # ------------ + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # inherit peer-session psession1 + # description Test_BGP_PEER_TEMPLATE_1 + # local-as 65537 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + + # Using deleted + + # Before state: + # -------------- + # + # nxos9k# show running-config | section "^router bgp" + # router bgp 65536 + # template peer neighbor_tmplt_1 + # capability suppress 4-byte-as + # description Test_BGP_PEER_TEMPLATE_1 + # bmp-activate-server 2 + # local-as 65536 + # remote-as 65001 + # address-family ipv4 unicast + # advertise-map rmap1 non-exist-map nemap1 + # advertisement-interval 60 + # disable-peer-as-check + # template peer neighbor_tmplt_2 + # description Test_BGP_PEER_TEMPLATE_2 + # inherit peer-session psession1 + # timers 45 100 + # address-family ipv4 multicast + # advertise-map rmap1 exist-map emap1 + # as-override + # filter-list flist1 in + # filter-list flist2 out + + - name: Delete BGP configs handled by this module + cisco.nxos.nxos_bgp_templates: + state: deleted + + # Task output: + # ------------ + # + # before: + # as_number: "65536" + # neighbor: + # - name: neighbor_tmplt_1 + # address_family: + # - afi: ipv4 + # safi: unicast + # advertise_map: + # non_exist_map: nemap1 + # route_map: rmap1 + # advertisement_interval: 60 + # disable_peer_as_check: true + # bmp_activate_server: 2 + # capability: + # suppress_4_byte_as: true + # description: Test_BGP_PEER_TEMPLATE_1 + # local_as: "65536" + # remote_as: "65001" + # + # - name: neighbor_tmplt_2 + # description: Test_BGP_PEER_TEMPLATE_2 + # address_family: + # - afi: ipv4 + # safi: multicast + # advertise_map: + # exist_map: emap1 + # route_map: rmap1 + # as_override: true + # filter_list: + # inbound: flist1 + # outbound: flist2 + # inherit: + # peer_session: psession1 + # timers: + # holdtime: 100 + # keepalive: 45 + # + # commands: + # - router bgp 65536 + # - no template peer neighbor_tmplt_1 + # - no template peer neighbor_tmplt_2 + # + # after: {} + + # After state: + # ------------- + # nxos9k# show running-config | section "^router bgp" + # nxos9k# + + + +Return Values +------------- +Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>after</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td>when changed</td> + <td> + <div>The resulting configuration after module execution.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>before</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td>when <em>state</em> is <code>merged</code>, <code>replaced</code>, <code>overridden</code>, <code>deleted</code> or <code>purged</code></td> + <td> + <div>The configuration prior to the module execution.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>commands</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>merged</code>, <code>replaced</code>, <code>overridden</code>, <code>deleted</code> or <code>purged</code></td> + <td> + <div>The set of commands pushed to the remote device.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['router bgp 65536', 'template peer neighbor_tmplt_1', 'no bmp-activate-server 2', 'no capability suppress 4-byte-as', 'inherit peer-session psession1', 'local-as 65537', 'no remote-as 65001', 'no template peer neighbor_tmplt_2']</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>gathered</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td>when <em>state</em> is <code>gathered</code></td> + <td> + <div>Facts about the network resource gathered from the remote device as structured data.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>parsed</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td>when <em>state</em> is <code>parsed</code></td> + <td> + <div>The device native config provided in <em>running_config</em> option parsed into structured data as per module argspec.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>rendered</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>rendered</code></td> + <td> + <div>The provided configuration in the task rendered in device-native format (offline).</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['router bgp 65536', 'template peer neighbor_tmplt_1', 'bmp-activate-server 2', 'no capability suppress 4-byte-as', 'no template peer neighbor_tmplt_2']</div> + </td> + </tr> + </table> + <br/><br/> + + +Status +------ + + +Authors +~~~~~~~ + +- Nilashish Chakraborty (@NilashishC) diff --git a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_fc_interfaces_module.rst b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_fc_interfaces_module.rst new file mode 100644 index 000000000..eaad900f2 --- /dev/null +++ b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_fc_interfaces_module.rst @@ -0,0 +1,777 @@ +.. _cisco.nxos.nxos_fc_interfaces_module: + + +***************************** +cisco.nxos.nxos_fc_interfaces +***************************** + +**Fc Interfaces resource module** + + +Version added: 5.2.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages the interface attributes of NX-OS fc interfaces. + + + + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="2">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>config</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + / <span style="color: purple">elements=dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dictionary of interface options</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>analytics</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>fc-scsi</li> + <li>fc-nvme</li> + <li>fc-all</li> + </ul> + </td> + <td> + <div>Analytics type on the fc interface</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>description</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>Interface description.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>enabled</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Administrative state of the interface. Set the value to <code>true</code> to administratively enable the interface or <code>false</code> to disable it</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>mode</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>auto</li> + <li>E</li> + <li>F</li> + <li>Fx</li> + <li>NP</li> + <li>SD</li> + </ul> + </td> + <td> + <div>Port mode of the fc interface</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>name</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + / <span style="color: red">required</span> + </div> + </td> + <td> + </td> + <td> + <div>Full name of interface, e.g. fc1/1, fc18/48</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>speed</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>auto</li> + <li>1000</li> + <li>2000</li> + <li>4000</li> + <li>8000</li> + <li>10000</li> + <li>16000</li> + <li>32000</li> + <li>64000</li> + <li>auto max 2000</li> + <li>auto max 4000</li> + <li>auto max 8000</li> + <li>auto max 16000</li> + <li>auto max 32000</li> + <li>auto max 64000</li> + </ul> + </td> + <td> + <div>Interface link speed.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>trunk_mode</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>auto</li> + <li>on</li> + <li>off</li> + </ul> + </td> + <td> + <div>Trunk mode of the fc interface</div> + </td> + </tr> + + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>running_config</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>This option is used only with state <em>parsed</em>.</div> + <div>The value of this option should be the output received from the NX-OS device by executing the command <b>show running-config interface</b></div> + <div>The state <em>parsed</em> reads the configuration from <code>running_config</code> option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the <em>parsed</em> key within the result.</div> + </td> + </tr> + <tr> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>state</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li><div style="color: blue"><b>merged</b> ←</div></li> + <li>replaced</li> + <li>overridden</li> + <li>deleted</li> + <li>gathered</li> + <li>rendered</li> + <li>parsed</li> + </ul> + </td> + <td> + <div>The state of the configuration after module completion</div> + </td> + </tr> + </table> + <br/> + + +Notes +----- + +.. note:: + - Tested against NXOS 9.3(2) on Cisco MDS Switches + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + # switch# show running-config interface all + # interface fc18/10 + # analytics type fc-nvme + # switchport speed auto max 16000 + # switchport mode auto + # switchport description $ + # switchport trunk mode on + # shutdown + + - name: Merge provided configuration with device configuration + cisco.nxos.nxos_fc_interfaces: + config: + - name: fc18/10 + analytics: fc-scsi + state: merged + + # Task Output + # ----------- + # + # before: + # - name: fc18/10 + # speed: auto max 16000 + # mode: auto + # trunk_mode: on + # enabled: False + # description: $ + # analytics: fc-nvme + # commands: + # - interface fc18/10 + # - analytics type fc-scsi + # after: + # - name: fc18/10 + # speed: auto max 16000 + # mode: auto + # trunk_mode: on + # enabled: False + # description: $ + # analytics: fc-all + + # After state: + # ------------ + # + # switch# show running-config interface all + # interface fc18/10 + # analytics type fc-scsi + # analytics type fc-nvme + # switchport speed auto max 16000 + # switchport mode auto + # switchport description $ + # switchport trunk mode on + # shutdown + + # Using replaced + + # Before state: + # ------------- + # + # switch# show running-config interface all + # interface fc18/12 + # analytics type fc-scsi + # analytics type fc-nvme + # switchport speed auto max 64000 + # switchport mode auto + # switchport description 1 + # switchport trunk mode on + # no shutdown + + - name: Replaces device configuration of listed interfaces with provided configuration + cisco.nxos.nxos_fc_interfaces: + config: + - name: fc18/12 + speed: auto max 64000 + mode: auto + trunk_mode: on + enabled: True + description: 1 + analytics: fc-scsi + state: replaced + + # Task Output + # ----------- + # + # before: + # - name: fc18/12 + # speed: auto max 64000 + # mode: auto + # trunk_mode: on + # enabled: True + # description: 1 + # analytics: fc-all + # commands: + # - interface fc18/12 + # - no analytics type fc-all + # - analytics type fc-scsi + # after: + # - name: fc18/12 + # speed: auto max 64000 + # mode: auto + # trunk_mode: on + # enabled: True + # description: 1 + # analytics: fc-scsi + + # After state: + # ------------ + # + # switch# show running-config interface all + # interface fc18/12 + # analytics type fc-scsi + # switchport speed auto max 64000 + # switchport mode auto + # switchport description 1 + # switchport trunk mode on + # no shutdown + + + # Using deleted + + # Before state: + # ------------- + # + # switch# show running-config interface all + # interface fc1/2 + # switchport speed 1000 + # switchport mode E + # no switchport description + # switchport trunk mode off + # no shutdown + + - name: Delete or return interface parameters to default settings + cisco.nxos.nxos_fc_interfaces: + config: + - name: fc1/2 + state: deleted + + # Task Output + # ----------- + # + # before: + # - name: fc1/2 + # speed: 1000 + # mode: E + # trunk_mode: off + # enabled: True + # commands: + # - interface fc1/2 + # - no switchport speed 1000 + # - no switchport mode E + # - switchport trunk mode on + # - shutdown + # after: + # - name: fc1/2 + # speed: auto + # mode: auto + # trunk_mode: on + # enabled: False + + # After state: + # ------------ + # + # switch# show running-config interface all + # interface fc1/2 + # switchport speed auto + # switchport mode auto + # no switchport description + # switchport trunk mode on + # shutdown + + # Using overridden + + # Before state: + # ------------- + # + # switch# show running-config interface all + # interface fc18/12 + # analytics type fc-scsi + # analytics type fc-nvme + # switchport speed auto max 64000 + # switchport mode auto + # switchport description 1 + # switchport trunk mode on + # no shutdown + # interface fc18/13 + # analytics type fc-scsi + # analytics type fc-nvme + # switchport speed auto max 64000 + # switchport mode auto + # switchport description 1 + # switchport trunk mode on + # no shutdown + + - name: Replaces device configuration of listed interfaces with provided configuration + cisco.nxos.nxos_fc_interfaces: + config: + - name: fc18/12 + speed: auto max 64000 + mode: auto + trunk_mode: on + enabled: True + description: 1 + analytics: fc-scsi + state: overridden + + # Task Output + # ----------- + # + # before: + # - name: fc18/12 + # speed: auto max 64000 + # mode: auto + # trunk_mode: on + # enabled: True + # description: 1 + # analytics: fc-all + # - name: fc18/13 + # speed: auto max 64000 + # mode: auto + # trunk_mode: on + # enabled: True + # description: 1 + # analytics: fc-all + # commands: + # - interface fc18/12 + # no analytics type fc-all + # analytics type fc-scsi + # - interface fc18/13 + # no switchport description + # no switchport speed auto max 64000 + # no switchport mode auto + # switchport trunk mode on + # shutdown + # after: + # - name: fc18/12 + # speed: auto max 64000 + # mode: auto + # trunk_mode: on + # enabled: True + # description: 1 + # analytics: fc-scsi + # - name: fc18/13 + # speed: auto max 64000 + # mode: auto + # trunk_mode: on + # enabled: False + + # After state: + # ------------ + # + # switch# show running-config interface all + # interface fc18/12 + # analytics type fc-scsi + # switchport speed auto max 64000 + # switchport mode auto + # switchport description 1 + # switchport trunk mode on + # no shutdown + # interface fc18/13 + # switchport mode auto + # switchport trunk mode on + # shutdown + + + + + + + + # Using rendered + + - name: Use rendered state to convert task input to device specific commands + cisco.nxos.nxos_fc_interfaces: + config: + - name: fc1/1 + speed: auto + mode: auto + trunk_mode: on + enabled: True + description: This is a sample line + - name: fc1/2 + speed: 1000 + mode: E + trunk_mode: off + enabled: True + state: rendered + + # Task Output + # ----------- + # + # rendered: + # interface fc1/1 + # switchport speed auto + # switchport mode auto + # switchport description This is a sample line + # switchport trunk mode on + # no shutdown + # + # interface fc1/2 + # switchport speed 1000 + # switchport mode E + # no switchport description + # switchport trunk mode off + # no shutdown + + # Using parsed + + # parsed.cfg + # ------------ + # + # interface fc1/1 + # switchport speed auto + # switchport mode auto + # switchport description This is a sample line + # switchport trunk mode on + # no shutdown + # + # interface fc1/2 + # switchport speed 1000 + # switchport mode E + # no switchport description + # switchport trunk mode off + # no shutdown + + - name: Use parsed state to convert externally supplied config to structured format + cisco.nxos.nxos_fc_interfaces: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task output + # ----------- + # + # parsed: + # - name: fc1/1 + # speed: auto + # mode: auto + # trunk_mode: on + # enabled: True + # description: This is a sample line + # - name: fc1/2 + # speed: 1000 + # mode: E + # trunk_mode: off + # enabled: True + + # Using gathered + + # Before state: + # ------------- + # + # switch# show running-config | section interface + # interface fc1/1 + # switchport speed auto + # switchport mode auto + # switchport description This is a sample line + # switchport trunk mode on + # no shutdown + # + # interface fc1/2 + # switchport speed 1000 + # switchport mode E + # no switchport description + # switchport trunk mode off + # no shutdown + # + - name: Gather interfaces facts from the device using nxos_fc_interfaces + cisco.nxos.nxos_fc_interfaces: + state: gathered + # + # Task output + # ----------- + # + # - name: fc1/1 + # speed: auto + # mode: auto + # trunk_mode: on + # enabled: True + # description: This is a sample line + # - name: fc1/2 + # speed: 1000 + # mode: E + # trunk_mode: off + # enabled: True + + + +Return Values +------------- +Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module: + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Key</th> + <th>Returned</th> + <th width="100%">Description</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>after</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td>when changed</td> + <td> + <div>The resulting configuration after module execution.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>before</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td>when <em>state</em> is <code>merged</code>, <code>replaced</code>, <code>overridden</code>, <code>deleted</code> or <code>purged</code></td> + <td> + <div>The configuration prior to the module execution.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>commands</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>merged</code>, <code>replaced</code>, <code>overridden</code>, <code>deleted</code> or <code>purged</code></td> + <td> + <div>The set of commands pushed to the remote device.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['interface fc1/1', 'description sample description', 'shutdown']</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>gathered</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>gathered</code></td> + <td> + <div>Facts about the network resource gathered from the remote device as structured data.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>parsed</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>parsed</code></td> + <td> + <div>The device native config provided in <em>running_config</em> option parsed into structured data as per module argspec.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>rendered</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>rendered</code></td> + <td> + <div>The provided configuration in the task rendered in device-native format (offline).</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['interface fc1/1', 'description sample description', 'shutdown']</div> + </td> + </tr> + </table> + <br/><br/> + + +Status +------ + + +Authors +~~~~~~~ + +- Suhas Bharadwaj (@srbharadwaj) diff --git a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_lacp_module.rst b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_lacp_module.rst index 81fcb8fc2..b0410c783 100644 --- a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_lacp_module.rst +++ b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_lacp_module.rst @@ -171,6 +171,7 @@ Parameters <ul style="margin: 0; padding: 0"><b>Choices:</b> <li><div style="color: blue"><b>merged</b> ←</div></li> <li>replaced</li> + <li>overridden</li> <li>deleted</li> <li>gathered</li> <li>rendered</li> @@ -179,6 +180,7 @@ Parameters </td> <td> <div>The state of the configuration after module completion.</div> + <div>States <code>replaced</code> and <code>overridden</code> have the same behaviour for this module.</div> </td> </tr> </table> diff --git a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_lldp_global_module.rst b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_lldp_global_module.rst index 0f012f985..57252cfe0 100644 --- a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_lldp_global_module.rst +++ b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_lldp_global_module.rst @@ -414,6 +414,7 @@ Parameters <ul style="margin: 0; padding: 0"><b>Choices:</b> <li><div style="color: blue"><b>merged</b> ←</div></li> <li>replaced</li> + <li>overridden</li> <li>deleted</li> <li>gathered</li> <li>rendered</li> @@ -421,7 +422,8 @@ Parameters </ul> </td> <td> - <div>The state of the configuration after module completion</div> + <div>The state of the configuration after module completion.</div> + <div>States <code>replaced</code> and <code>overridden</code> have the same behaviour for this module.</div> </td> </tr> </table> diff --git a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_ospf_interfaces_module.rst b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_ospf_interfaces_module.rst index 19ba44ab1..6dbfbd5f5 100644 --- a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_ospf_interfaces_module.rst +++ b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_ospf_interfaces_module.rst @@ -826,122 +826,77 @@ Examples key: 12090404011C03162E state: merged - # Task output - # ------------- - # "before": [ - # { - # "name": "Ethernet1/1" - # }, - # { - # "name": "Ethernet1/2" - # }, - # { - # "name": "Ethernet1/3" - # }, - # ] + # Task output: + # ------------ + # before: + # - name: Ethernet1/1 + # - name: Ethernet1/2 + # - name: Ethernet1/3 # - # "commands": [ - # "interface Ethernet1/1", - # "ip router ospf multi-area 11.11.11.11", - # "ip router ospf 100 area 1.1.1.1 secondaries none", - # "ipv6 router ospfv3 multi-area 16.10.10.10", - # "ipv6 router ospfv3 200 area 2.2.2.2", - # "ipv6 router ospfv3 200 multi-area 21.0.0.0", - # "ipv6 router ospfv3 300 multi-area 50.50.50.50", - # "interface Ethernet1/2", - # "ip ospf authentication key-chain test-1", - # "ip ospf authentication", - # "ip ospf message-digest-key 10 md5 3 abc01d272be25d29", - # "ip ospf cost 100", - # "ospfv3 network broadcast", - # "ospfv3 shutdown", - # "interface Ethernet1/3", - # "ip ospf authentication-key 7 12090404011C03162E" - # ] + # commands: + # - interface Ethernet1/1 + # - ip router ospf multi-area 11.11.11.11 + # - ip router ospf 100 area 1.1.1.1 secondaries none + # - ipv6 router ospfv3 multi-area 16.10.10.10 + # - ipv6 router ospfv3 200 area 2.2.2.2 + # - ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - ipv6 router ospfv3 300 multi-area 50.50.50.50 + # - interface Ethernet1/2 + # - ip ospf authentication key-chain test-1 + # - ip ospf authentication + # - ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # - ip ospf cost 100 + # - ospfv3 network broadcast + # - ospfv3 shutdown + # - interface Ethernet1/3 + # - ip ospf authentication-key 7 12090404011C03162E # - # "after": [ - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "multi_areas": [ - # "11.11.11.11" - # ], - # "processes": [ - # { - # "area": { - # "area_id": "1.1.1.1", - # "secondaries": false - # }, - # "process_id": "100" - # } - # ] - # }, - # { - # "afi": "ipv6", - # "multi_areas": [ - # "16.10.10.10" - # ], - # "processes": [ - # { - # "area": { - # "area_id": "2.2.2.2" - # }, - # "multi_areas": [ - # "21.0.0.0" - # ], - # "process_id": "200" - # }, - # { - # "multi_areas": [ - # "50.50.50.50" - # ], - # "process_id": "300" - # } - # ] - # } - # ], - # "name": "Ethernet1/1" - # }, - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "authentication": { - # "enable": true, - # "key_chain": "test-1" - # }, - # "cost": 100, - # "message_digest_key": { - # "encryption": 3, - # "key": "abc01d272be25d29", - # "key_id": 10 - # } - # }, - # { - # "afi": "ipv6", - # "network": "broadcast", - # "shutdown": true - # } - # ], - # "name": "Ethernet1/2" - # }, - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "authentication_key": { - # "encryption": 7, - # "key": "12090404011C03162E" - # } - # } - # ], - # "name": "Ethernet1/3" - # }, - # ] + # after: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 # After state: - # ------------- + # ------------ # NXOS# show running-config | section ^interface # interface Ethernet1/1 # no switchport @@ -967,7 +922,7 @@ Examples # Using replaced # Before state: - # ------------ + # ------------- # NXOS# show running-config | section ^interface # interface Ethernet1/1 # no switchport @@ -1005,151 +960,92 @@ Examples - name: Ethernet1/3 state: replaced - # Task output - # ------------- - # "before": [ - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "multi_areas": [ - # "11.11.11.11" - # ], - # "processes": [ - # { - # "area": { - # "area_id": "1.1.1.1", - # "secondaries": false - # }, - # "process_id": "100" - # } - # ] - # }, - # { - # "afi": "ipv6", - # "multi_areas": [ - # "16.10.10.10" - # ], - # "processes": [ - # { - # "area": { - # "area_id": "2.2.2.2" - # }, - # "multi_areas": [ - # "21.0.0.0" - # ], - # "process_id": "200" - # }, - # { - # "multi_areas": [ - # "50.50.50.50" - # ], - # "process_id": "300" - # } - # ] - # } - # ], - # "name": "Ethernet1/1" - # }, - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "authentication": { - # "enable": true, - # "key_chain": "test-1" - # }, - # "cost": 100, - # "message_digest_key": { - # "encryption": 3, - # "key": "abc01d272be25d29", - # "key_id": 10 - # } - # }, - # { - # "afi": "ipv6", - # "network": "broadcast", - # "shutdown": true - # } - # ], - # "name": "Ethernet1/2" - # }, - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "authentication_key": { - # "encryption": 7, - # "key": "12090404011C03162E" - # } - # } - # ], - # "name": "Ethernet1/3" - # }, - # ] + # Task output: + # ------------ + # before: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 # - # "commands": [ - # "interface Ethernet1/1", - # "ip router ospf multi-area 11.11.11.12", - # "no ip router ospf multi-area 11.11.11.11", - # "no ipv6 router ospfv3 multi-area 16.10.10.10", - # "no ipv6 router ospfv3 200 area 2.2.2.2", - # "no ipv6 router ospfv3 200 multi-area 21.0.0.0", - # "no ipv6 router ospfv3 300 multi-area 50.50.50.50", - # "interface Ethernet1/3", - # "no ip ospf authentication-key 7 12090404011C03162E" - # ] + # commands: + # - interface Ethernet1/1 + # - ip router ospf multi-area 11.11.11.12 + # - no ip router ospf multi-area 11.11.11.11 + # - no ipv6 router ospfv3 multi-area 16.10.10.10 + # - no ipv6 router ospfv3 200 area 2.2.2.2 + # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 + # - interface Ethernet1/3 + # - no ip ospf authentication-key 7 12090404011C03162E # - # "after": [ - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "multi_areas": [ - # "11.11.11.12" - # ], - # "processes": [ - # { - # "area": { - # "area_id": "1.1.1.1", - # "secondaries": false - # }, - # "process_id": "100" - # } - # ] - # } - # ], - # "name": "Ethernet1/1" - # }, - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "authentication": { - # "enable": true, - # "key_chain": "test-1" - # }, - # "cost": 100, - # "message_digest_key": { - # "encryption": 3, - # "key": "abc01d272be25d29", - # "key_id": 10 - # } - # }, - # { - # "afi": "ipv6", - # "network": "broadcast", - # "shutdown": true - # } - # ], - # "name": "Ethernet1/2" - # }, - # { - # "name": "Ethernet1/3" - # }, + # after: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.12 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - name: Ethernet1/3 # # After state: - # ------------- + # ------------ # NXOS# show running-config | section ^interface # interface Ethernet1/1 # no switchport @@ -1170,7 +1066,7 @@ Examples # Using overridden # Before state: - # ------------ + # ------------- # NXOS# show running-config | section ^interface # interface Ethernet1/1 # no switchport @@ -1207,136 +1103,83 @@ Examples - 11.11.11.12 state: overridden - # Task output - # ------------- - # "before": [ - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "multi_areas": [ - # "11.11.11.11" - # ], - # "processes": [ - # { - # "area": { - # "area_id": "1.1.1.1", - # "secondaries": false - # }, - # "process_id": "100" - # } - # ] - # }, - # { - # "afi": "ipv6", - # "multi_areas": [ - # "16.10.10.10" - # ], - # "processes": [ - # { - # "area": { - # "area_id": "2.2.2.2" - # }, - # "multi_areas": [ - # "21.0.0.0" - # ], - # "process_id": "200" - # }, - # { - # "multi_areas": [ - # "50.50.50.50" - # ], - # "process_id": "300" - # } - # ] - # } - # ], - # "name": "Ethernet1/1" - # }, - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "authentication": { - # "enable": true, - # "key_chain": "test-1" - # }, - # "cost": 100, - # "message_digest_key": { - # "encryption": 3, - # "key": "abc01d272be25d29", - # "key_id": 10 - # } - # }, - # { - # "afi": "ipv6", - # "network": "broadcast", - # "shutdown": true - # } - # ], - # "name": "Ethernet1/2" - # }, - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "authentication_key": { - # "encryption": 7, - # "key": "12090404011C03162E" - # } - # } - # ], - # "name": "Ethernet1/3" - # }, - # ] + # Task output: + # ------------ + # before: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 # - # "commands": [ - # "interface Ethernet1/2", - # "no ip ospf authentication key-chain test-1", - # "no ip ospf authentication", - # "no ip ospf message-digest-key 10 md5 3 abc01d272be25d29", - # "no ip ospf cost 100", - # "no ospfv3 network broadcast", - # "no ospfv3 shutdown", - # "interface Ethernet1/3", - # "no ip ospf authentication-key 7 12090404011C03162E", - # "interface Ethernet1/1", - # "ip router ospf multi-area 11.11.11.12", - # "no ip router ospf multi-area 11.11.11.11", - # "no ipv6 router ospfv3 multi-area 16.10.10.10", - # "no ipv6 router ospfv3 200 area 2.2.2.2", - # "no ipv6 router ospfv3 200 multi-area 21.0.0.0", - # "no ipv6 router ospfv3 300 multi-area 50.50.50.50" - # ] + # commands: + # - interface Ethernet1/2 + # - no ip ospf authentication key-chain test-1 + # - no ip ospf authentication + # - no ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # - no ip ospf cost 100 + # - no ospfv3 network broadcast + # - no ospfv3 shutdown + # - interface Ethernet1/3 + # - no ip ospf authentication-key 7 12090404011C03162E + # - interface Ethernet1/1 + # - ip router ospf multi-area 11.11.11.12 + # - no ip router ospf multi-area 11.11.11.11 + # - no ipv6 router ospfv3 multi-area 16.10.10.10 + # - no ipv6 router ospfv3 200 area 2.2.2.2 + # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 # - # "after": [ - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "multi_areas": [ - # "11.11.11.12" - # ], - # "processes": [ - # { - # "area": { - # "area_id": "1.1.1.1", - # "secondaries": false - # }, - # "process_id": "100" - # } - # ] - # } - # ], - # "name": "Ethernet1/1" - # }, - # { - # "name": "Ethernet1/2" - # }, - # { - # "name": "Ethernet1/3" - # }, - # ] + # after: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.12 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # name: Ethernet1/1 + # - name: Ethernet1/2 + # - name: Ethernet1/3 # After state: # ------------- @@ -1353,7 +1196,7 @@ Examples # Using deleted to delete OSPF config of a single interface # Before state: - # ------------ + # ------------- # NXOS# show running-config | section ^interface # interface Ethernet1/1 # no switchport @@ -1381,139 +1224,84 @@ Examples - name: Ethernet1/1 state: deleted - # Task output - # ------------- - # "before": [ - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "multi_areas": [ - # "11.11.11.11" - # ], - # "processes": [ - # { - # "area": { - # "area_id": "1.1.1.1", - # "secondaries": false - # }, - # "process_id": "100" - # } - # ] - # }, - # { - # "afi": "ipv6", - # "multi_areas": [ - # "16.10.10.10" - # ], - # "processes": [ - # { - # "area": { - # "area_id": "2.2.2.2" - # }, - # "multi_areas": [ - # "21.0.0.0" - # ], - # "process_id": "200" - # }, - # { - # "multi_areas": [ - # "50.50.50.50" - # ], - # "process_id": "300" - # } - # ] - # } - # ], - # "name": "Ethernet1/1" - # }, - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "authentication": { - # "enable": true, - # "key_chain": "test-1" - # }, - # "cost": 100, - # "message_digest_key": { - # "encryption": 3, - # "key": "abc01d272be25d29", - # "key_id": 10 - # } - # }, - # { - # "afi": "ipv6", - # "network": "broadcast", - # "shutdown": true - # } - # ], - # "name": "Ethernet1/2" - # }, - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "authentication_key": { - # "encryption": 7, - # "key": "12090404011C03162E" - # } - # } - # ], - # "name": "Ethernet1/3" - # }, - # ] + # Task output: + # ------------ + # before: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 # - # "commands": [ - # "interface Ethernet1/1", - # "no ip router ospf multi-area 11.11.11.11", - # "no ip router ospf 100 area 1.1.1.1 secondaries none", - # "no ipv6 router ospfv3 multi-area 16.10.10.10", - # "no ipv6 router ospfv3 200 area 2.2.2.2", - # "no ipv6 router ospfv3 200 multi-area 21.0.0.0", - # "no ipv6 router ospfv3 300 multi-area 50.50.50.50" - # ] + # commands: + # - interface Ethernet1/1 + # - no ip router ospf multi-area 11.11.11.11 + # - no ip router ospf 100 area 1.1.1.1 secondaries none + # - no ipv6 router ospfv3 multi-area 16.10.10.10 + # - no ipv6 router ospfv3 200 area 2.2.2.2 + # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 # - # "before": [ - # { - # "name": "Ethernet1/1" - # }, - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "authentication": { - # "enable": true, - # "key_chain": "test-1" - # }, - # "cost": 100, - # "message_digest_key": { - # "encryption": 3, - # "key": "abc01d272be25d29", - # "key_id": 10 - # } - # }, - # { - # "afi": "ipv6", - # "network": "broadcast", - # "shutdown": true - # } - # ], - # "name": "Ethernet1/2" - # }, - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "authentication_key": { - # "encryption": 7, - # "key": "12090404011C03162E" - # } - # } - # ], - # "name": "Ethernet1/3" - # }, - # ] + # after: + # - name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 + # After state: # ------------ @@ -1535,7 +1323,7 @@ Examples # Using deleted to delete OSPF config from all interfaces # Before state: - # ------------ + # ------------- # NXOS# show running-config | section ^interface # interface Ethernet1/1 # no switchport @@ -1561,119 +1349,53 @@ Examples cisco.nxos.nxos_ospf_interfaces: state: deleted - # Task output - # ------------- - # "before": [ - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "multi_areas": [ - # "11.11.11.11" - # ], - # "processes": [ - # { - # "area": { - # "area_id": "1.1.1.1", - # "secondaries": false - # }, - # "process_id": "100" - # } - # ] - # }, - # { - # "afi": "ipv6", - # "multi_areas": [ - # "16.10.10.10" - # ], - # "processes": [ - # { - # "area": { - # "area_id": "2.2.2.2" - # }, - # "multi_areas": [ - # "21.0.0.0" - # ], - # "process_id": "200" - # }, - # { - # "multi_areas": [ - # "50.50.50.50" - # ], - # "process_id": "300" - # } - # ] - # } - # ], - # "name": "Ethernet1/1" - # }, - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "authentication": { - # "enable": true, - # "key_chain": "test-1" - # }, - # "cost": 100, - # "message_digest_key": { - # "encryption": 3, - # "key": "abc01d272be25d29", - # "key_id": 10 - # } - # }, - # { - # "afi": "ipv6", - # "network": "broadcast", - # "shutdown": true - # } - # ], - # "name": "Ethernet1/2" - # }, - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "authentication_key": { - # "encryption": 7, - # "key": "12090404011C03162E" - # } - # } - # ], - # "name": "Ethernet1/3" - # }, - # ] + # Task output: + # ------------ + # before: + # - name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 # - # "commands": [ - # "interface Ethernet1/1", - # "no ip router ospf multi-area 11.11.11.11", - # "no ip router ospf 100 area 1.1.1.1 secondaries none", - # "no ipv6 router ospfv3 multi-area 16.10.10.10", - # "no ipv6 router ospfv3 200 area 2.2.2.2", - # "no ipv6 router ospfv3 200 multi-area 21.0.0.0", - # "no ipv6 router ospfv3 300 multi-area 50.50.50.50", - # "interface Ethernet1/2", - # "no ip ospf authentication key-chain test-1", - # "no ip ospf authentication", - # "no ip ospf message-digest-key 10 md5 3 abc01d272be25d29", - # "no ip ospf cost 100", - # "no ospfv3 network broadcast", - # "no ospfv3 shutdown", - # "interface Ethernet1/3", - # "no ip ospf authentication-key 7 12090404011C03162E" - # ] + # commands: + # - interface Ethernet1/1 + # - no ip router ospf multi-area 11.11.11.11 + # - no ip router ospf 100 area 1.1.1.1 secondaries none + # - no ipv6 router ospfv3 multi-area 16.10.10.10 + # - no ipv6 router ospfv3 200 area 2.2.2.2 + # - no ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - no ipv6 router ospfv3 300 multi-area 50.50.50.50 + # - interface Ethernet1/2 + # - no ip ospf authentication key-chain test-1 + # - no ip ospf authentication + # - no ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # - no ip ospf cost 100 + # - no ospfv3 network broadcast + # - no ospfv3 shutdown + # - interface Ethernet1/3 + # - no ip ospf authentication-key 7 12090404011C03162E # - # "after": [ - # { - # "name": "Ethernet1/1" - # }, - # { - # "name": "Ethernet1/2" - # }, - # { - # "name": "Ethernet1/3" - # }, - # ] + # after: + # - name: Ethernet1/1 + # - name: Ethernet1/2 + # - name: Ethernet1/3 # After state: # ------------ @@ -1734,26 +1456,25 @@ Examples key: 12090404011C03162E state: rendered - # Task Output (redacted) - # ----------------------- - # "rendered": [ - # "interface Ethernet1/1", - # "ip router ospf multi-area 11.11.11.11", - # "ip router ospf 100 area 1.1.1.1 secondaries none", - # "ipv6 router ospfv3 multi-area 16.10.10.10", - # "ipv6 router ospfv3 200 area 2.2.2.2", - # "ipv6 router ospfv3 200 multi-area 21.0.0.0", - # "ipv6 router ospfv3 300 multi-area 50.50.50.50", - # "interface Ethernet1/2", - # "ip ospf authentication key-chain test-1", - # "ip ospf authentication", - # "ip ospf message-digest-key 10 md5 3 abc01d272be25d29", - # "ip ospf cost 100", - # "ospfv3 network broadcast", - # "ospfv3 shutdown", - # "interface Ethernet1/3", - # "ip ospf authentication-key 7 12090404011C03162E" - # ] + # Task Output: + # ------------ + # rendered: + # - interface Ethernet1/1 + # - ip router ospf multi-area 11.11.11.11 + # - ip router ospf 100 area 1.1.1.1 secondaries none + # - ipv6 router ospfv3 multi-area 16.10.10.10 + # - ipv6 router ospfv3 200 area 2.2.2.2 + # - ipv6 router ospfv3 200 multi-area 21.0.0.0 + # - ipv6 router ospfv3 300 multi-area 50.50.50.50 + # - interface Ethernet1/2 + # - ip ospf authentication key-chain test-1 + # - ip ospf authentication + # - ip ospf message-digest-key 10 md5 3 abc01d272be25d29 + # - ip ospf cost 100 + # - ospfv3 network broadcast + # - ospfv3 shutdown + # - interface Ethernet1/3 + # - ip ospf authentication-key 7 12090404011C03162E # Using parsed @@ -1781,88 +1502,51 @@ Examples running_config: "{{ lookup('file', 'ospf_interfaces.cfg') }}" state: parsed - # Task output (redacted) - # ----------------------- - # "parsed": [ - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "multi_areas": [ - # "11.11.11.11" - # ], - # "processes": [ - # { - # "area": { - # "area_id": "1.1.1.1", - # "secondaries": false - # }, - # "process_id": "100" - # } - # ] - # }, - # { - # "afi": "ipv6", - # "multi_areas": [ - # "16.10.10.10" - # ], - # "processes": [ - # { - # "area": { - # "area_id": "2.2.2.2" - # }, - # "multi_areas": [ - # "21.0.0.0" - # ], - # "process_id": "200" - # }, - # { - # "multi_areas": [ - # "50.50.50.50" - # ], - # "process_id": "300" - # } - # ] - # } - # ], - # "name": "Ethernet1/1" - # }, - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "authentication": { - # "enable": true, - # "key_chain": "test-1" - # }, - # "cost": 100, - # "message_digest_key": { - # "encryption": 3, - # "key": "abc01d272be25d29", - # "key_id": 10 - # } - # }, - # { - # "afi": "ipv6", - # "network": "broadcast", - # "shutdown": true - # } - # ], - # "name": "Ethernet1/2" - # }, - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "authentication_key": { - # "encryption": 7, - # "key": "12090404011C03162E" - # } - # } - # ], - # "name": "Ethernet1/3" - # }, - # ] + # Task output: + # ------------ + # parsed: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.11 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # - afi: ipv6 + # multi_areas: + # - 16.10.10.10 + # processes: + # - area: + # area_id: 2.2.2.2 + # multi_areas: + # - 21.0.0.0 + # process_id: '200' + # - multi_areas: + # - 50.50.50.50 + # process_id: '300' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - address_family: + # - afi: ipv4 + # authentication_key: + # encryption: 7 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # name: Ethernet1/3 # Using gathered @@ -1884,55 +1568,34 @@ Examples # interface Ethernet1/3 # no switchport - # Task output (redacted) - # ----------------------- - # "gathered": [ - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "multi_areas": [ - # "11.11.11.12" - # ], - # "processes": [ - # { - # "area": { - # "area_id": "1.1.1.1", - # "secondaries": false - # }, - # "process_id": "100" - # } - # ] - # } - # ], - # "name": "Ethernet1/1" - # }, - # { - # "address_family": [ - # { - # "afi": "ipv4", - # "authentication": { - # "enable": true, - # "key_chain": "test-1" - # }, - # "cost": 100, - # "message_digest_key": { - # "encryption": 3, - # "key": "abc01d272be25d29", - # "key_id": 10 - # } - # }, - # { - # "afi": "ipv6", - # "network": "broadcast", - # "shutdown": true - # } - # ], - # "name": "Ethernet1/2" - # }, - # { - # "name": "Ethernet1/3" - # }, + # Task output: + # ------------ + # gathered: + # - address_family: + # - afi: ipv4 + # multi_areas: + # - 11.11.11.12 + # processes: + # - area: + # area_id: 1.1.1.1 + # secondaries: false + # process_id: '100' + # name: Ethernet1/1 + # - address_family: + # - afi: ipv4 + # authentication: + # enable: true + # key_chain: test-1 + # cost: 100 + # message_digest_key: + # encryption: 3 + # key: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER + # key_id: 10 + # - afi: ipv6 + # network: broadcast + # shutdown: true + # name: Ethernet1/2 + # - name: Ethernet1/3 @@ -2001,6 +1664,57 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['interface Ethernet1/1', 'ip router ospf multi-area 11.11.11.11', 'ip router ospf 100 area 1.1.1.1 secondaries none', 'no ipv6 router ospfv3 multi-area 16.10.10.10', 'ipv6 router ospfv3 200 area 2.2.2.2', 'ipv6 router ospfv3 200 multi-area 21.0.0.0', 'ipv6 router ospfv3 300 multi-area 50.50.50.50', 'interface Ethernet1/2', 'no ip ospf authentication key-chain test-1', 'ip ospf authentication']</div> </td> </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>gathered</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>gathered</code></td> + <td> + <div>Facts about the network resource gathered from the remote device as structured data.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>parsed</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>parsed</code></td> + <td> + <div>The device native config provided in <em>running_config</em> option parsed into structured data as per module argspec.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>rendered</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>rendered</code></td> + <td> + <div>The provided configuration in the task rendered in device-native format (offline).</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['interface Ethernet1/1', 'ip router ospf multi-area 11.11.11.11', 'ip router ospf 100 area 1.1.1.1 secondaries none']</div> + </td> + </tr> </table> <br/><br/> diff --git a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_ospfv2_module.rst b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_ospfv2_module.rst index fabb4d7e4..bc5613068 100644 --- a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_ospfv2_module.rst +++ b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_ospfv2_module.rst @@ -4484,8 +4484,8 @@ Examples unit: Gbps state: merged - # Task output - # ------------- + # Task output: + # ------------ # before: {} # # commands: @@ -4650,8 +4650,8 @@ Examples no_summary: true state: replaced - # Task output - # ------------- + # Task output: + # ------------ # before: # processes: # - process_id: "100" @@ -4810,8 +4810,8 @@ Examples shutdown: true state: overridden - # Task output - # ------------- + # Task output: + # ------------ # before: # processes: # - process_id: "100" @@ -4928,8 +4928,8 @@ Examples - process_id: 102 state: deleted - # Task output - # ------------- + # Task output: + # ------------ # before: # processes: # - process_id: "100" @@ -5024,8 +5024,8 @@ Examples cisco.nxos.nxos_ospfv2: state: deleted - # Task output - # ------------- + # Task output: + # ------------ # before: # processes: # - process_id: "100" @@ -5144,8 +5144,8 @@ Examples unit: Gbps state: rendered - # Task Output (redacted) - # ----------------------- + # Task output: + # ------------ # rendered: # - router ospf 100 # - router-id 203.0.113.20 @@ -5208,8 +5208,8 @@ Examples running_config: "{{ lookup('file', 'ospfv2.cfg') }}" state: parsed - # Task output (redacted) - # ----------------------- + # Task output: + # ------------ # parsed: # processes: # - process_id: "100" @@ -5283,8 +5283,8 @@ Examples cisco.nxos.nxos_ospfv2: state: gathered - # Task output (redacted) - # ----------------------- + # Task output: + # ------------ # gathered: # processes: # - process_id: "102" @@ -5387,6 +5387,57 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['router ospf 102', 'router-id 198.54.100.1', 'router ospf 100', 'router-id 192.0.100.1', 'redistribute eigrp 120 route-map rmap_1', 'redistribute direct route-map ospf-direct-connect', 'area 0.0.0.100 filter-list route-map rmap_1 in', 'area 0.0.0.100 filter-list route-map rmap_2 out', 'area 0.0.0.100 range 192.0.2.0/24 not-advertise', 'area 0.0.0.100 range 192.0.3.0/24 cost 120', 'vrf zone1', 'router-id 192.0.100.2', 'summary-address 10.0.0.0/24 tag 121', 'summary-address 11.0.0.0/24', 'redistribute static route-map zone1-direct-connect', 'vrf zone2', 'auto-cost reference-bandwidth 45 Gbps', 'capability vrf-lite evpn']</div> </td> </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>gathered</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td>when <em>state</em> is <code>gathered</code></td> + <td> + <div>Facts about the network resource gathered from the remote device as structured data.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>parsed</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td>when <em>state</em> is <code>parsed</code></td> + <td> + <div>The device native config provided in <em>running_config</em> option parsed into structured data as per module argspec.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>rendered</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>rendered</code></td> + <td> + <div>The provided configuration in the task rendered in device-native format (offline).</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['router ospf 102', 'router-id 198.54.100.1', 'router ospf 100']</div> + </td> + </tr> </table> <br/><br/> diff --git a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_ospfv3_module.rst b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_ospfv3_module.rst index 0fa5710ed..0c4c9efed 100644 --- a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_ospfv3_module.rst +++ b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_ospfv3_module.rst @@ -3615,8 +3615,8 @@ Examples unit: Gbps state: merged - # Task output - # ------------- + # Task output: + # ------------ # before: {} # # commands: @@ -3711,7 +3711,7 @@ Examples # Using replaced # Before state: - # ------------ + # ------------- # nxos-9k-rdo# sh running-config | section "^router ospfv3" # router ospfv3 100 # router-id 203.0.113.20 @@ -3765,8 +3765,8 @@ Examples no_summary: True state: replaced - # Task output - # ------------- + # Task output: + # ------------ # before: # processes: # - process_id: "100" @@ -3877,7 +3877,7 @@ Examples # Using overridden # Before state: - # ------------ + # ------------- # nxos-9k-rdo# sh running-config | section "^router ospfv3" # router ospfv3 100 # router-id 203.0.113.20 @@ -3909,8 +3909,8 @@ Examples shutdown: true state: overridden - # Task output - # ------------- + # Task output: + # ------------ # before: # processes: # - process_id: "100" @@ -3997,7 +3997,7 @@ Examples # Using deleted to delete a single OSPF process # Before state: - # ------------ + # ------------- # nxos-9k-rdo# sh running-config | section "^router ospf .*" # router ospfv3 100 # router-id 203.0.113.20 @@ -4025,8 +4025,8 @@ Examples - process_id: 102 state: deleted - # Task output - # ------------- + # Task output: + # ------------ # before: # processes: # - process_id: "100" @@ -4090,7 +4090,7 @@ Examples # Using deleted all OSPFv3 processes from the device # Before state: - # ------------ + # ------------- # nxos-9k-rdo# sh running-config | section "^router ospfv3" # router ospfv3 100 # router-id 203.0.113.20 @@ -4115,8 +4115,8 @@ Examples cisco.nxos.nxos_ospfv3: state: deleted - # Task output - # ------------- + # Task output: + # ------------ # before: # processes: # - process_id: "100" @@ -4225,8 +4225,8 @@ Examples unit: Gbps state: rendered - # Task Output (redacted) - # ----------------------- + # Task output: + # ------------ # rendered: # - router ospfv3 100 # - router-id 203.0.113.20 @@ -4272,8 +4272,8 @@ Examples running_config: "{{ lookup('file', 'ospfv2.cfg') }}" state: parsed - # Task output (redacted) - # ----------------------- + # Task output: + # ------------ # parsed: # processes: # - process_id: "100" @@ -4323,8 +4323,8 @@ Examples cisco.nxos.nxos_ospfv3: state: gathered - # Task output (redacted) - # ----------------------- + # Task output: + # ------------ # gathered: # processes: # - process_id: "100" @@ -4439,6 +4439,57 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['router ospfv3 102', 'router-id 198.54.100.1', 'router ospfv3 100', 'router-id 192.0.100.1', 'address-family ipv6 unicast', 'redistribute eigrp 120 route-map rmap_1', 'redistribute direct route-map ospf-direct-connect', 'area 0.0.0.100 filter-list route-map rmap_1 in', 'area 0.0.0.100 filter-list route-map rmap_2 out', 'area 0.0.0.100 range 2001:db2::/32 not-advertise', 'area 0.0.0.100 range 2001:db3::/32 cost 120', 'vrf zone1', 'router-id 192.0.100.2', 'vrf zone2', 'auto-cost reference-bandwidth 45 Gbps']</div> </td> </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>gathered</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td>when <em>state</em> is <code>gathered</code></td> + <td> + <div>Facts about the network resource gathered from the remote device as structured data.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>parsed</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td>when <em>state</em> is <code>parsed</code></td> + <td> + <div>The device native config provided in <em>running_config</em> option parsed into structured data as per module argspec.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>rendered</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>rendered</code></td> + <td> + <div>The provided configuration in the task rendered in device-native format (offline).</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['router ospfv3 102', 'router-id 198.54.100.1', 'router ospfv3 100']</div> + </td> + </tr> </table> <br/><br/> diff --git a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_route_maps_module.rst b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_route_maps_module.rst index 817967670..6ced43a16 100644 --- a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_route_maps_module.rst +++ b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_route_maps_module.rst @@ -1888,6 +1888,91 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="4"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>extcommunity</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Set BGP extcommunity attribute.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>rt</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>Route-Target.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>additive</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Add to existing rt extcommunity.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>extcommunity_numbers</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + / <span style="color: purple">elements=string</span> + </div> + </td> + <td> + </td> + <td> + <div>Extcommunity number.</div> + <div>Supported formats are ASN2:NN, ASN4:NN, IPV4:NN.</div> + </td> + </tr> + + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>forwarding_address</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> diff --git a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_static_routes_module.rst b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_static_routes_module.rst index 4c5be4a96..264515ecf 100644 --- a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_static_routes_module.rst +++ b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_static_routes_module.rst @@ -348,7 +348,7 @@ Notes ----- .. note:: - - Tested against NX-OS 7.3.(0)D1(1) on VIRL + - Tested against Nexus 9300v running NX-OS 9.3.6 on CML. - Unsupported for Cisco MDS - When a route is configured for a non-existent VRF, the VRF is created and the route is added to it. - When deleting routes for a VRF, all routes inside the VRF are deleted, but the VRF is not deleted. @@ -360,13 +360,15 @@ Examples .. code-block:: yaml - # Using deleted: + # Using deleted - delete all # Before state: # ------------- # + # switch# show running-config | include '^ip(v6)* route' # ip route 192.0.2.32/28 192.0.2.12 name new_route # ip route 192.0.2.26/24 192.0.2.13 tag 12 + # switch# show running-config | section '^vrf context' - name: Delete all routes cisco.nxos.nxos_static_routes: @@ -374,6 +376,7 @@ Examples # Task Output # ----------- + # # before: # - address_families: # - afi: ipv4 @@ -387,20 +390,24 @@ Examples # - forward_router_address: 192.0.2.12 # route_name: new_route # commands: - # - configure terminal # - no ip route 192.0.2.0/24 192.0.2.13 tag 12 # - no ip route 192.0.2.32/28 192.0.2.12 name new_route # after: [] + # After state: # ------------ - # + # switch# show running-config | include '^ip(v6)* route' + # switch# show running-config | section '^vrf context' + # Using deleted - vrf based # Before state: # ------------ # + # switch# show running-config | include '^ip(v6)* route' # ip route 192.0.2.16/28 192.0.2.24 name new_route # ip route 192.0.2.80/28 192.0.2.26 tag 12 + # switch# show running-config | section '^vrf context' # vrf context trial_vrf # ip route 192.0.2.64/28 192.0.2.22 tag 4 # ip route 192.0.2.64/28 192.0.2.23 name merged_route 1 @@ -414,6 +421,7 @@ Examples # Task Output # ----------- + # # before: # - address_families: # - afi: ipv4 @@ -464,16 +472,22 @@ Examples # After state: # ----------- + # + # switch# show running-config | include '^ip(v6)* route' # ip route 192.0.2.16/28 192.0.2.24 name new_route # ip route 192.0.2.80/28 192.0.2.26 tag 12 + # switch# show running-config | section '^vrf context' # vrf context trial_vrf + # Using deleted - afi based # Before state: # ------------ # + # switch# show running-config | include '^ip(v6)* route' # ip route 192.0.2.16/28 192.0.2.24 name new_route # ip route 192.0.2.80/28 192.0.2.26 tag 12 + # switch# show running-config | section '^vrf context' # vrf context trial_vrf # ip route 192.0.2.64/28 192.0.2.22 tag 4 # ip route 192.0.2.64/28 192.0.2.23 name merged_route 1 @@ -489,6 +503,7 @@ Examples # Task Output # ----------- + # # before: # - address_families: # - afi: ipv4 @@ -547,8 +562,11 @@ Examples # After state: # ----------- + # + # switch# show running-config | include '^ip(v6)* route' # ip route 192.0.2.16/28 192.0.2.24 name new_route # ip route 192.0.2.80/28 192.0.2.26 tag 12 + # switch# show running-config | section '^vrf context' # vrf context trial_vrf # ipv6 route 2200:10::/36 2048:ae12::1 vrf dest 5 @@ -556,7 +574,8 @@ Examples # Before state: # ------------- - # + # switch# show running-config | include '^ip(v6)* route' + # switch# show running-config | section '^vrf context' - name: Merge new static route configuration cisco.nxos.nxos_static_routes: @@ -570,7 +589,6 @@ Examples - forward_router_address: 192.0.2.22 tag: 4 admin_distance: 2 - - address_families: - afi: ipv4 routes: @@ -588,11 +606,11 @@ Examples # Task Output # ----------- + # # before:[] # commands: # - vrf context trial_vrf # - ip route 192.0.2.64/24 192.0.2.22 tag 4 2 - # - configure terminal # - ip route 192.0.2.16/24 192.0.2.24 name new_route # - ipv6 route 2001:db8::/64 Ethernet1/3 2001:db8::12 # after: @@ -605,7 +623,6 @@ Examples # - forward_router_address: 192.0.2.22 # tag: 4 # admin_distance: 2 - # # - address_families: # - afi: ipv4 # routes: @@ -623,24 +640,27 @@ Examples # After state: # ------------ # + # switch# show running-config | include '^ip(v6)* route' # ip route 192.0.2.16/24 192.0.2.24 name new_route # ipv6 route 2001:db8::/64 Ethernet1/3 2001:db8::12 + # switch# show running-config | section '^vrf context' # vrf context trial_vrf # ip route 192.0.2.0/24 192.0.2.22 tag 4 2 - - # Using overridden: + # Using overridden # Before state: # ------------- # + # switch# show running-config | include '^ip(v6)* route' # ip route 192.0.2.16/28 192.0.2.24 name new_route # ip route 192.0.2.80/28 192.0.2.26 tag 12 + # switch# show running-config | section '^vrf context' # vrf context trial_vrf # ip route 192.0.2.64/28 192.0.2.22 tag 4 # ip route 192.0.2.64/28 192.0.2.23 name merged_route 1 - - name: Overriden existing static route configuration with new configuration + - name: Overridden existing static route configuration with new configuration cisco.nxos.nxos_static_routes: config: - vrf: trial_vrf @@ -652,7 +672,6 @@ Examples - forward_router_address: 192.0.2.23 route_name: overridden_route1 admin_distance: 3 - - forward_router_address: 192.0.2.45 route_name: overridden_route2 dest_vrf: destinationVRF @@ -661,6 +680,7 @@ Examples # Task Output # ----------- + # # before: # - address_families: # - afi: ipv4 @@ -685,7 +705,6 @@ Examples # - forward_router_address: 192.0.2.26 # tag: 12 # commands: - # - configure terminal # - no ip route 192.0.2.16/28 192.0.2.24 name new_route # - no ip route 192.0.2.80/28 192.0.2.26 tag 12 # - vrf context trial_vrf @@ -711,17 +730,21 @@ Examples # After state: # ------------ # + # switch# show running-config | include '^ip(v6)* route' + # switch# show running-config | section '^vrf context' # vrf context trial_vrf # ip route 192.0.2.16/28 192.0.2.23 name overridden_route1 3 # ip route 192.0.2.16/28 Ethernet1/2 192.0.2.45 vrf destinationVRF name overridden_route2 - - # Using replaced: + # Using replaced # Before state: # ------------ + # + # switch# show running-config | include '^ip(v6)* route' # ip route 192.0.2.16/28 192.0.2.24 name new_route # ip route 192.0.2.80/28 192.0.2.26 tag 12 + # switch# show running-config | section '^vrf context' # vrf context trial_vrf # ip route 192.0.2.64/28 192.0.2.22 tag 4 # ip route 192.0.2.64/28 192.0.2.23 name merged_route 1 @@ -737,7 +760,6 @@ Examples - forward_router_address: 192.0.2.23 route_name: replaced_route1 admin_distance: 3 - - forward_router_address: 192.0.2.45 route_name: replaced_route2 dest_vrf: destinationVRF @@ -746,6 +768,7 @@ Examples # Task Output # ----------- + # # before: # - address_families: # - afi: ipv4 @@ -770,7 +793,6 @@ Examples # - forward_router_address: 192.0.2.26 # tag: 12 # commands: - # - configure terminal # - no ip route 192.0.2.16/28 192.0.2.24 name new_route # - ip route 192.0.2.16/28 192.0.2.23 name replaced_route1 3 # - ip route 192.0.2.16/28 Ethernet1/2 192.0.2.45 vrf destinationVRF name replaced_route2 @@ -804,29 +826,37 @@ Examples # tag: 12 # After state: - # ----------- + # ------------ + # + # switch# show running-config | include '^ip(v6)* route' # ip route 192.0.2.16/28 192.0.2.23 name replaced_route1 3 # ip route 192.0.2.16/28 Ethernet1/2 192.0.2.45 vrf destinationVRF name replaced_route2 # ip route 192.0.2.80/28 192.0.2.26 tag 12 + # switch# show running-config | section '^vrf context' # vrf context trial_vrf # ip route 192.0.2.64/28 192.0.2.22 tag 4 # ip route 192.0.2.64/28 192.0.2.23 name merged_route 1 - # Using gathered: + # Using gathered # Before state: # ------------- + # + # switch# show running-config | include '^ip(v6)* route' # ipv6 route 2001:db8:12::/32 2001:db8::12 + # switch# show running-config | section '^vrf context' # vrf context Test # ip route 192.0.2.48/28 192.0.2.13 # ip route 192.0.2.48/28 192.0.2.14 5 - - name: Gather the exisitng condiguration + - name: Gather the existing configuration cisco.nxos.nxos_static_routes: state: gathered - # returns: + # Task Output + # ----------- + # # gathered: # - vrf: Test # address_families: @@ -847,7 +877,7 @@ Examples # - forward_router_address: 2001:db8::12 - # Using rendered: + # Using rendered - name: Render required configuration to be pushed to the device cisco.nxos.nxos_static_routes: @@ -858,7 +888,6 @@ Examples - dest: 192.0.2.48/28 next_hops: - forward_router_address: 192.0.2.13 - - afi: ipv6 routes: - dest: 2001:db8::/64 @@ -867,24 +896,28 @@ Examples forward_router_address: 2001:db8::12 state: rendered - # returns + # Task Output + # ----------- + # # rendered: # vrf context default # ip route 192.0.2.48/28 192.0.2.13 # ipv6 route 2001:db8::/64 Ethernet1/3 2001:db8::12 - # Using parsed - name: Parse the config to structured data cisco.nxos.nxos_static_routes: + state: parsed running_config: | ipv6 route 2002:db8:12::/32 2002:db8:12::1 vrf context Test ip route 192.0.2.48/28 192.0.2.13 ip route 192.0.2.48/28 192.0.2.14 5 - # returns: + # Task Output + # ----------- + # # parsed: # - vrf: Test # address_families: @@ -893,10 +926,8 @@ Examples # - dest: 192.0.2.48/28 # next_hops: # - forward_router_address: 192.0.2.13 - # # - forward_router_address: 192.0.2.14 # admin_distance: 5 - # # - address_families: # - afi: ipv6 # routes: @@ -929,11 +960,10 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late </td> <td>when changed</td> <td> - <div>The resulting configuration model invocation.</div> + <div>The resulting configuration after module execution.</div> <br/> <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">The configuration returned will always be in the same format - of the parameters above.</div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> </td> </tr> <tr> @@ -945,13 +975,12 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late <span style="color: purple">list</span> </div> </td> - <td>always</td> + <td>when <em>state</em> is <code>merged</code>, <code>replaced</code>, <code>overridden</code>, <code>deleted</code> or <code>purged</code></td> <td> - <div>The configuration prior to the model invocation.</div> + <div>The configuration prior to the module execution.</div> <br/> <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">The configuration returned will always be in the same format - of the parameters above.</div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> </td> </tr> <tr> @@ -963,12 +992,63 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late <span style="color: purple">list</span> </div> </td> - <td>always</td> + <td>when <em>state</em> is <code>merged</code>, <code>replaced</code>, <code>overridden</code>, <code>deleted</code> or <code>purged</code></td> <td> <div>The set of commands pushed to the remote device.</div> <br/> <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['ip route 192.0.2.48/28 192.0.2.12 Ethernet1/2 name sample_route', 'ipv6 route 2001:db8:3000::/36 2001:db8:200:2::2', 'vrf context test', 'ip route 192.0.2.48/28 192.0.2.121']</div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['ip route 192.0.2.16/28 192.0.2.24 name new_route', 'vrf context trial_vrf', 'ip route 192.0.2.16/28 192.0.2.23 name overridden_route1 3']</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>gathered</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>gathered</code></td> + <td> + <div>Facts about the network resource gathered from the remote device as structured data.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>parsed</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>parsed</code></td> + <td> + <div>The device native config provided in <em>running_config</em> option parsed into structured data as per module argspec.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> + <b>rendered</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + </div> + </td> + <td>when <em>state</em> is <code>rendered</code></td> + <td> + <div>The provided configuration in the task rendered in device-native format (offline).</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['ip route 192.0.2.16/28 192.0.2.24 name new_route', 'vrf context trial_vrf', 'ip route 192.0.2.16/28 192.0.2.23 name overridden_route1 3']</div> </td> </tr> </table> @@ -983,3 +1063,4 @@ Authors ~~~~~~~ - Adharsh Srivats Rangarajan (@adharshsrivatsr) +- Sagar Paul (@KB-perByte) diff --git a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_vtp_version_module.rst b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_vtp_version_module.rst index 9271dbe28..996e950ff 100644 --- a/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_vtp_version_module.rst +++ b/ansible_collections/cisco/nxos/docs/cisco.nxos.nxos_vtp_version_module.rst @@ -47,6 +47,7 @@ Parameters <ul style="margin: 0; padding: 0"><b>Choices:</b> <li>1</li> <li>2</li> + <li>3</li> </ul> </td> <td> @@ -80,9 +81,6 @@ Examples # ENSURE VTP VERSION IS 2 - cisco.nxos.nxos_vtp_version: version: 2 - host: '{{ inventory_hostname }}' - username: '{{ un }}' - password: '{{ pwd }}' |