diff options
Diffstat (limited to '')
27 files changed, 10317 insertions, 1775 deletions
diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_acl_interfaces_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_acl_interfaces_module.rst index cbdf96bcc..b188ba816 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_acl_interfaces_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_acl_interfaces_module.rst @@ -442,7 +442,7 @@ Examples # ip access-group 123 out # Using DELETED without any config passed - #"(NOTE: This will delete all of configured resource module attributes from each configured interface)" + # "(NOTE: This will delete all of configured resource module attributes from each configured interface)" # Before state: # ------------- diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_acls_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_acls_module.rst index e0b61c7ed..a76156dd6 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_acls_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_acls_module.rst @@ -3143,6 +3143,8 @@ Parameters </td> <td> <div>The remarks/description of the ACL.</div> + <div>The remarks attribute used within an ace with or without a sequence number will produce remarks that are pushed before the ace entry.</div> + <div>Remarks entry used as the only key in as the list option will produce non ace specific remarks, these remarks would be pushed at the end of all the aces for an acl.</div> </td> </tr> <tr> @@ -3880,7 +3882,7 @@ Parameters <div>The states <em>rendered</em>, <em>gathered</em> and <em>parsed</em> does not perform any change on the device.</div> <div>The state <em>rendered</em> will transform the configuration in <code>config</code> option to platform specific CLI commands which will be returned in the <em>rendered</em> key within the result. For state <em>rendered</em> active connection to remote host is not required.</div> <div>The state <em>gathered</em> will fetch the running configuration from device and transform it into structured data in the format as per the resource module argspec and the value is returned in the <em>gathered</em> key within the result.</div> - <div>The state <em>parsed</em> reads the configuration from <code>running_config</code> option and transforms it into JSON format as per the resource module parameters and the value is returned in the <em>parsed</em> key within the result. The value of <code>running_config</code> option should be the same format as the output of commands <em>show access-list</em> and <em>show running-config | include ip(v6</em>* access-list|remark) executed on device. Config data from both the commands should be kept together one after another for the parsers to pick the commands correctly. For state <em>parsed</em> active connection to remote host is not required.</div> + <div>The state <em>parsed</em> reads the configuration from <code>running_config</code> option and transforms it into JSON format as per the resource module parameters and the value is returned in the <em>parsed</em> key within the result. The value of <code>running_config</code> option should be the same format as the output of commands <em>sh running-config | section access-list</em> for all acls related information and <em>sh access-lists | include access list</em> to obtain configuration specific of an empty acls, the following commands are executed on device. Config data from both the commands should be kept together one after another for the parsers to pick the commands correctly. For state <em>parsed</em> active connection to remote host is not required.</div> <div>The state <em>overridden</em>, modify/add the ACLs defined, deleted all other ACLs.</div> <div>The state <em>replaced</em>, modify/add only the ACEs of the ACLs defined only. It does not perform any other change on the device.</div> <div>The state <em>deleted</em>, deletes only the specified ACLs, or all if not specified.</div> @@ -3910,35 +3912,8 @@ Examples # Before state: # ------------- # - # vios#sh access-lists - # Extended IP access list 100 - # 10 deny icmp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 echo dscp ef ttl eq 10 - - - name: Merge provided configuration with device configuration - cisco.ios.ios_acls: - config: - - afi: ipv4 - acls: - - name: 100 - aces: - - sequence: 10 - protocol_options: - icmp: - traceroute: true - state: merged - - # After state: - # ------------ - # - # Play Execution fails, with error: - # Cannot update existing sequence 10 of ACLs 100 with state merged. - # Please use state replaced or overridden. - - # Before state: - # ------------- - # - # vios#sh access-lists - # Extended IP access list 110 + # vios#sh running-config | section access-list + # ip access-list extended 110 # 10 deny icmp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 echo dscp ef ttl eq 10 - name: Merge provided configuration with device configuration @@ -3962,6 +3937,12 @@ Examples protocol_options: icmp: traceroute: true + source: + address: 192.168.3.0 + wildcard_bits: 255.255.255.0 + destination: + any: true + grant: permit - grant: deny protocol_options: tcp: @@ -3972,7 +3953,7 @@ Examples host: 198.51.110.0 port_protocol: eq: telnet - - name: test + - name: extended_acl_1 acl_type: extended aces: - grant: deny @@ -4044,64 +4025,259 @@ Examples dscp: af11 state: merged - # Commands fired: - # --------------- + # Task Output + # ----------- # - # - ip access-list standard std_acl - # - deny 192.168.1.200 - # - deny 192.168.2.0 0.0.0.255 - # - ip access-list extended 110 - # - 10 deny icmp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 traceroute dscp ef ttl eq 10 - # - deny tcp host 198.51.100.0 host 198.51.110.0 eq telnet ack - # - ip access-list extended test - # - deny tcp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 eq www fin option traceroute ttl eq 10 - # - ip access-list extended 123 - # - deny tcp 198.51.100.0 0.0.0.255 198.51.101.0 0.0.0.255 eq telnet ack tos 12 - # - deny tcp 192.0.3.0 0.0.0.255 192.0.4.0 0.0.0.255 eq www ack dscp ef ttl lt 20 - # - remark remarks for extended ACL 1 - # - remark check ACL - # - ipv6 access-list R1_TRAFFIC - # - deny tcp any eq www any eq telnet ack dscp af11 + # before: + # - acls: + # - aces: + # - destination: + # address: 192.0.3.0 + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: icmp + # protocol_options: + # icmp: + # echo: true + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # eq: 10 + # acl_type: extended + # name: '100' + # afi: ipv4 + # commands: + # - ip access-list extended 110 + # - deny tcp host 198.51.100.0 host 198.51.110.0 eq telnet ack + # - 30 permit icmp 192.168.3.0 255.255.255.0 any traceroute + # - ip access-list extended extended_acl_1 + # - deny tcp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 eq www fin option traceroute ttl eq 10 + # - ip access-list standard std_acl + # - deny 192.168.1.20 + # - deny 192.168.2.0 0.0.0.255 + # - ip access-list extended 123 + # - deny tcp 198.51.100.0 0.0.0.255 198.51.101.0 0.0.0.255 eq telnet ack tos 12 + # - deny tcp 192.0.3.0 0.0.0.255 192.0.4.0 0.0.0.255 eq www ack dscp ef ttl lt 20 + # - remark remarks for extended ACL 1 + # - remark check ACL + # - ipv6 access-list R1_TRAFFIC + # - deny tcp any eq www any eq telnet ack dscp af11 + # after: + # - acls: + # - aces: + # - destination: + # address: 192.0.3.0 + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: icmp + # protocol_options: + # icmp: + # echo: true + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # eq: 10 + # - destination: + # host: 198.51.110.0 + # port_protocol: + # eq: telnet + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 20 + # source: + # host: 198.51.100.0 + # - destination: + # any: true + # grant: permit + # protocol: icmp + # protocol_options: + # icmp: + # traceroute: true + # sequence: 30 + # source: + # address: 0.0.0.0 + # wildcard_bits: 255.255.255.0 + # acl_type: extended + # name: '110' + # - aces: + # - destination: + # address: 198.51.101.0 + # port_protocol: + # eq: telnet + # wildcard_bits: 0.0.0.255 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 10 + # source: + # address: 198.51.100.0 + # wildcard_bits: 0.0.0.255 + # tos: + # service_value: 12 + # - destination: + # address: 192.0.4.0 + # port_protocol: + # eq: www + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 20 + # source: + # address: 192.0.3.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # lt: 20 + # - remarks: + # - remarks for extended ACL 1 + # - check ACL + # acl_type: extended + # name: '123' + # - aces: + # - destination: + # address: 192.0.3.0 + # port_protocol: + # eq: www + # wildcard_bits: 0.0.0.255 + # grant: deny + # option: + # traceroute: true + # protocol: tcp + # protocol_options: + # tcp: + # fin: true + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # eq: 10 + # acl_type: extended + # name: extended_acl_1 + # - aces: + # - grant: deny + # sequence: 10 + # source: + # host: 192.168.1.20 + # - grant: deny + # sequence: 20 + # source: + # address: 192.168.2.0 + # wildcard_bits: 0.0.0.255 + # acl_type: standard + # name: std_acl + # afi: ipv4 + # - acls: + # - aces: + # - destination: + # any: true + # port_protocol: + # eq: telnet + # dscp: af11 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 10 + # source: + # any: true + # port_protocol: + # eq: www + # name: R1_TRAFFIC + # afi: ipv6 # After state: # ------------ # - # vios#sh access-lists - # Standard IP access list std_acl + # vios#sh running-config | section access-list + # ip access-list standard std_acl # 10 deny 192.168.1.200 - # 20 deny 192.168.2.0, wildcard bits 0.0.0.255 - # Extended IP access list 100 + # 20 deny 192.168.2.0 0.0.0.255 + # ip access-list extended 100 # 10 deny icmp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 echo dscp ef ttl eq 10 - # Extended IP access list 110 + # ip access-list extended 110 # 10 deny icmp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 traceroute dscp ef ttl eq 10 # 20 deny tcp host 198.51.100.0 host 198.51.110.0 eq telnet ack - # Extended IP access list 123 + # ip access-list extended 123 # 10 deny tcp 198.51.100.0 0.0.0.255 198.51.101.0 0.0.0.255 eq telnet ack tos 12 # 20 deny tcp 192.0.3.0 0.0.0.255 192.0.4.0 0.0.0.255 eq www ack dscp ef ttl lt 20 - # Extended IP access list test + # ip access-list extended test # 10 deny tcp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 eq www fin option traceroute ttl eq 10 - # IPv6 access list R1_TRAFFIC - # deny tcp any eq www any eq telnet ack dscp af11 sequence 10 + # ipv6 access-list R1_TRAFFIC + # sequence 10 deny tcp any eq www any eq telnet ack dscp af11 + + # vios#show running-config | include ip(v6)* access-list|remark + # ip access-list standard std_acl + # ip access-list extended extended_acl_1 + # ip access-list extended 110 + # ip access-list extended 123 + # remark remarks for extended ACL 1 + # remark check ACL + # ipv6 access-list R1_TRAFFIC + + # Using merged (update existing ACE - will fail) + + # Before state: + # ------------- + # + # vios#sh running-config | section access-list + # ip access-list extended 100 + # 10 deny icmp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 echo dscp ef ttl eq 10 + + - name: Merge provided configuration with device configuration + cisco.ios.ios_acls: + config: + - afi: ipv4 + acls: + - name: 100 + aces: + - sequence: 10 + protocol_options: + icmp: + traceroute: true + state: merged + + # After state: + # ------------ + # + # Play Execution fails, with error: + # Cannot update existing sequence 10 of ACLs 100 with state merged. + # Please use state replaced or overridden. # Using replaced # Before state: # ------------- # - # vios#sh access-lists - # Standard IP access list std_acl - # 10 deny 192.168.1.200 - # 20 deny 192.168.2.0, wildcard bits 0.0.0.255 - # Extended IP access list 110 - # 10 deny icmp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 traceroute dscp ef ttl eq 10 - # 20 deny tcp host 198.51.100.0 host 198.51.110.0 eq telnet ack - # Extended IP access list 123 - # 10 deny tcp 198.51.100.0 0.0.0.255 198.51.101.0 0.0.0.255 eq telnet ack tos 12 - # 20 deny tcp 192.0.3.0 0.0.0.255 192.0.4.0 0.0.0.255 eq www ack dscp ef ttl lt 20 - # Extended IP access list test - # 10 deny tcp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 eq www fin option traceroute ttl eq 10 - # IPv6 access list R1_TRAFFIC - # deny tcp any eq www any eq telnet ack dscp af11 sequence 10 + # vios#sh running-config | section access-list + # ip access-list standard std_acl + # 10 deny 192.168.1.200 + # 20 deny 192.168.2.0 0.0.0.255 + # ip access-list extended 110 + # 10 deny icmp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 traceroute dscp ef ttl eq 10 + # 20 deny tcp host 198.51.100.0 host 198.51.110.0 eq telnet ack + # ip access-list extended 123 + # 10 deny tcp 198.51.100.0 0.0.0.255 198.51.101.0 0.0.0.255 eq telnet ack tos 12 + # 20 deny tcp 192.0.3.0 0.0.0.255 192.0.4.0 0.0.0.255 eq www ack dscp ef ttl lt 20 + # ip access-list extended R1_TRAFFIC + # 10 deny tcp any eq www any eq telnet ack dscp af11 + # ip access-list extended test + # 10 deny tcp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 eq www fin option traceroute ttl eq 10 - name: Replaces device configuration of listed acls with provided configuration cisco.ios.ios_acls: @@ -4147,33 +4323,619 @@ Examples eq: 10 state: replaced - # Commands fired: - # --------------- + # Task Output + # ----------- # - # - no ip access-list extended 110 - # - ip access-list extended 110 - # - deny tcp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 eq www syn dscp ef ttl eq 10 - # - ip access-list extended 150 - # - 20 deny tcp 198.51.100.0 0.0.0.255 eq telnet 198.51.110.0 0.0.0.255 eq telnet syn dscp ef ttl eq 10 + # before: + # - acls: + # - aces: + # - destination: + # address: 192.0.3.0 + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: icmp + # protocol_options: + # icmp: + # traceroute: true + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # eq: 10 + # - destination: + # host: 198.51.110.0 + # port_protocol: + # eq: telnet + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 20 + # source: + # host: 198.51.100.0 + # acl_type: extended + # name: '110' + # - aces: + # - destination: + # address: 198.51.101.0 + # port_protocol: + # eq: telnet + # wildcard_bits: 0.0.0.255 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 10 + # source: + # address: 198.51.100.0 + # wildcard_bits: 0.0.0.255 + # tos: + # service_value: 12 + # - destination: + # address: 192.0.4.0 + # port_protocol: + # eq: www + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 20 + # source: + # address: 192.0.3.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # lt: 20 + # acl_type: extended + # name: '123' + # - aces: + # - destination: + # any: true + # port_protocol: + # eq: telnet + # dscp: af11 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 10 + # source: + # any: true + # port_protocol: + # eq: www + # acl_type: extended + # name: R1_TRAFFIC + # - aces: + # - grant: deny + # sequence: 10 + # source: + # host: 192.168.1.200 + # - grant: deny + # sequence: 20 + # source: + # address: 192.168.2.0 + # wildcard_bits: 0.0.0.255 + # acl_type: standard + # name: std_acl + # - aces: + # - destination: + # address: 192.0.3.0 + # port_protocol: + # eq: www + # wildcard_bits: 0.0.0.255 + # grant: deny + # option: + # traceroute: true + # protocol: tcp + # protocol_options: + # tcp: + # fin: true + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # eq: 10 + # acl_type: extended + # name: test + # afi: ipv4 + # commands: + # - ip access-list extended 110 + # - no 10 deny icmp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 traceroute dscp ef ttl eq 10 + # - no 20 deny tcp host 198.51.100.0 host 198.51.110.0 eq telnet ack + # - deny tcp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 eq www syn dscp ef ttl eq 10 + # - ip access-list extended 150 + # - 20 deny tcp 198.51.100.0 0.0.0.255 eq telnet 198.51.110.0 0.0.0.255 eq telnet syn dscp ef ttl eq 10 + # after: + # - acls: + # - aces: + # - destination: + # address: 192.0.3.0 + # port_protocol: + # eq: www + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # syn: true + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # eq: 10 + # acl_type: extended + # name: '110' + # - aces: + # - destination: + # address: 198.51.101.0 + # port_protocol: + # eq: telnet + # wildcard_bits: 0.0.0.255 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 10 + # source: + # address: 198.51.100.0 + # wildcard_bits: 0.0.0.255 + # tos: + # service_value: 12 + # - destination: + # address: 192.0.4.0 + # port_protocol: + # eq: www + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 20 + # source: + # address: 192.0.3.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # lt: 20 + # acl_type: extended + # name: '123' + # - aces: + # - destination: + # address: 198.51.110.0 + # port_protocol: + # eq: telnet + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # syn: true + # sequence: 20 + # source: + # address: 198.51.100.0 + # port_protocol: + # eq: telnet + # wildcard_bits: 0.0.0.255 + # ttl: + # eq: 10 + # acl_type: extended + # name: '150' + # - aces: + # - destination: + # any: true + # port_protocol: + # eq: telnet + # dscp: af11 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 10 + # source: + # any: true + # port_protocol: + # eq: www + # acl_type: extended + # name: R1_TRAFFIC + # - aces: + # - grant: deny + # sequence: 10 + # source: + # host: 192.168.1.200 + # - grant: deny + # sequence: 20 + # source: + # address: 192.168.2.0 + # wildcard_bits: 0.0.0.255 + # acl_type: standard + # name: std_acl + # - aces: + # - destination: + # address: 192.0.3.0 + # port_protocol: + # eq: www + # wildcard_bits: 0.0.0.255 + # grant: deny + # option: + # traceroute: true + # protocol: tcp + # protocol_options: + # tcp: + # fin: true + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # eq: 10 + # acl_type: extended + # name: test + # afi: ipv4 # After state: # ------------- # # vios#sh access-lists - # Standard IP access list std_acl + # ip access-list standard std_acl # 10 deny 192.168.1.200 - # 20 deny 192.168.2.0, wildcard bits 0.0.0.255 - # Extended IP access list 110 + # 20 deny 192.168.2.0 0.0.0.255 + # ip access-list extended 110 # 10 deny tcp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 eq www syn dscp ef ttl eq 10 - # Extended IP access list 123 + # ip access-list extended 123 # 10 deny tcp 198.51.100.0 0.0.0.255 198.51.101.0 0.0.0.255 eq telnet ack tos 12 # 20 deny tcp 192.0.3.0 0.0.0.255 192.0.4.0 0.0.0.255 eq www ack dscp ef ttl lt 20 - # Extended IP access list 150 + # ip access-list extended 150 # 20 deny tcp 198.51.100.0 0.0.0.255 eq telnet 198.51.110.0 0.0.0.255 eq telnet syn dscp ef ttl eq 10 - # Extended IP access list test + # ip access-list extended test # 10 deny tcp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 eq www fin option traceroute ttl eq 10 - # IPv6 access list R1_TRAFFIC - # deny tcp any eq www any eq telnet ack dscp af11 sequence 10 + # ipv6 access-list R1_TRAFFIC + # sequence 10 deny tcp any eq www any eq telnet ack dscp af11 + + # Using replaced - example remarks specific + + # Before state: + # ------------- + # + # vios#show running-config | section access-list + # ip access-list extended TEST + # 10 remark FIRST REMARK BEFORE LINE 10 + # 10 remark ============ + # 10 remark ALLOW HOST FROM TEST 10 + # 10 permit ip host 1.1.1.1 any + # 20 remark FIRST REMARK BEFORE LINE 20 + # 20 remark ============ + # 20 remark ALLOW HOST remarks AFTER LINE 20 + # 20 permit ip host 2.2.2.2 any + # 30 remark FIRST REMARK BEFORE LINE 30 + # 30 remark ============ + # 30 remark ALLOW HOST remarks AFTER LINE 30 + # 30 permit ip host 3.3.3.3 any + + - name: Replace remarks of ace with sequence 10 + # check_mode: true + cisco.ios.ios_acls: + state: replaced + config: + - acls: + - aces: + - destination: + any: true + grant: permit + protocol: ip + remarks: + - The new first remarks before 10 + - ============new + - The new second remarks before 10 + sequence: 10 + source: + host: 1.1.1.1 + - destination: + any: true + grant: permit + protocol: ip + remarks: + - FIRST REMARK BEFORE LINE 20 + - ============ + - ALLOW HOST remarks AFTER LINE 20 + sequence: 20 + source: + host: 2.2.2.2 + - destination: + any: true + grant: permit + protocol: ip + remarks: + - FIRST REMARK BEFORE LINE 30 + - ============ + - ALLOW HOST remarks AFTER LINE 30 + sequence: 30 + source: + host: 3.3.3.3 + acl_type: extended + name: TEST + afi: ipv4 + + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # remarks: + # - FIRST REMARK BEFORE LINE 10 + # - ===========1= + # - ALLOW HOST FROM TEST 10 + # sequence: 10 + # source: + # host: 1.1.1.1 + # - destination: + # any: true + # grant: permit + # protocol: ip + # remarks: + # - FIRST REMARK BEFORE LINE 20 + # - ============ + # - ALLOW HOST remarks AFTER LINE 20 + # sequence: 20 + # source: + # host: 2.2.2.2 + # - destination: + # any: true + # grant: permit + # protocol: ip + # remarks: + # - FIRST REMARK BEFORE LINE 30 + # - ============ + # - ALLOW HOST remarks AFTER LINE 30 + # sequence: 30 + # source: + # host: 3.3.3.3 + # acl_type: extended + # name: TEST + # afi: ipv4 + # commands: + # - ip access-list extended TEST + # - no 10 remark + # - 10 remark The new first remarks before 10 + # - 10 remark ============new + # - 10 remark The new second remarks before 10 + # after: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # remarks: + # - The new first remarks before 10 + # - ============new + # - The new second remarks before 10 + # sequence: 10 + # source: + # host: 1.1.1.1 + # - destination: + # any: true + # grant: permit + # protocol: ip + # remarks: + # - FIRST REMARK BEFORE LINE 20 + # - ============ + # - ALLOW HOST remarks AFTER LINE 20 + # sequence: 20 + # source: + # host: 2.2.2.2 + # - destination: + # any: true + # grant: permit + # protocol: ip + # remarks: + # - FIRST REMARK BEFORE LINE 30 + # - ============ + # - ALLOW HOST remarks AFTER LINE 30 + # sequence: 30 + # source: + # host: 3.3.3.3 + # acl_type: extended + # name: TEST + # afi: ipv4 + + # After state: + # ------------- + # + # foo#show running-config | section access-list + # ip access-list extended TEST + # 10 remark The new first remarks before 10 + # 10 remark ============new + # 10 remark The new second remarks before 10 + # 10 permit ip host 1.1.1.1 any + # 20 remark FIRST REMARK BEFORE LINE 20 + # 20 remark ============ + # 20 remark ALLOW HOST remarks AFTER LINE 20 + # 20 permit ip host 2.2.2.2 any + # 30 remark FIRST REMARK BEFORE LINE 30 + # 30 remark ============ + # 30 remark ALLOW HOST remarks AFTER LINE 30 + # 30 permit ip host 3.3.3.3 any + + # Using replaced - example remarks specific on targeted sequence + + # Before state: + # ------------- + # + # vios#show running-config | section access-list + # ip access-list extended TEST + # 10 permit ip host 1.1.1.1 any + # 20 remark FIRST REMARK BEFORE LINE 20 + # 20 remark ============ + # 20 remark ALLOW HOST remarks AFTER LINE 20 + # 20 permit ip host 2.2.2.2 any + # 30 remark FIRST REMARK BEFORE LINE 30 + # 30 remark ============ + # 30 remark ALLOW HOST remarks AFTER LINE 30 + # 30 permit ip host 3.3.3.3 any + + - name: Replace remarks of ace with sequence 10 + # check_mode: true + cisco.ios.ios_acls: + state: replaced + config: + - acls: + - aces: + - destination: + any: true + grant: permit + protocol: ip + remarks: + - The new first remarks before 10 + - ============new + - The new second remarks before 10 + sequence: 10 + source: + host: 1.1.1.1 + - destination: + any: true + grant: permit + protocol: ip + remarks: + - FIRST REMARK BEFORE LINE 20 + - ============ + - ALLOW HOST remarks AFTER LINE 20 + sequence: 20 + source: + host: 2.2.2.2 + - destination: + any: true + grant: permit + protocol: ip + remarks: + - FIRST REMARK BEFORE LINE 30 + - ============ + - ALLOW HOST remarks AFTER LINE 30 + sequence: 30 + source: + host: 3.3.3.3 + acl_type: extended + name: TEST + afi: ipv4 + + # Task Output + # ----------- + # + # before: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # sequence: 10 + # source: + # host: 1.1.1.1 + # - destination: + # any: true + # grant: permit + # protocol: ip + # remarks: + # - FIRST REMARK BEFORE LINE 20 + # - ============ + # - ALLOW HOST remarks AFTER LINE 20 + # sequence: 20 + # source: + # host: 2.2.2.2 + # - destination: + # any: true + # grant: permit + # protocol: ip + # remarks: + # - FIRST REMARK BEFORE LINE 30 + # - ============ + # - ALLOW HOST remarks AFTER LINE 30 + # sequence: 30 + # source: + # host: 3.3.3.3 + # acl_type: extended + # name: TEST + # afi: ipv4 + # commands: + # - ip access-list extended TEST + # - 10 remark The new first remarks before 10 + # - 10 remark ============new + # - 10 remark The new second remarks before 10 + # after: + # - acls: + # - aces: + # - destination: + # any: true + # grant: permit + # protocol: ip + # remarks: + # - The new first remarks before 10 + # - ============new + # - The new second remarks before 10 + # sequence: 10 + # source: + # host: 1.1.1.1 + # - destination: + # any: true + # grant: permit + # protocol: ip + # remarks: + # - FIRST REMARK BEFORE LINE 20 + # - ============ + # - ALLOW HOST remarks AFTER LINE 20 + # sequence: 20 + # source: + # host: 2.2.2.2 + # - destination: + # any: true + # grant: permit + # protocol: ip + # remarks: + # - FIRST REMARK BEFORE LINE 30 + # - ============ + # - ALLOW HOST remarks AFTER LINE 30 + # sequence: 30 + # source: + # host: 3.3.3.3 + # acl_type: extended + # name: TEST + # afi: ipv4 + + # After state: + # ------------- + # + # foo#show running-config | section access-list + # ip access-list extended TEST + # 10 remark The new first remarks before 10 + # 10 remark ============new + # 10 remark The new second remarks before 10 + # 10 permit ip host 1.1.1.1 any + # 20 remark FIRST REMARK BEFORE LINE 20 + # 20 remark ============ + # 20 remark ALLOW HOST remarks AFTER LINE 20 + # 20 permit ip host 2.2.2.2 any + # 30 remark FIRST REMARK BEFORE LINE 30 + # 30 remark ============ + # 30 remark ALLOW HOST remarks AFTER LINE 30 + # 30 permit ip host 3.3.3.3 any # Using overridden @@ -4181,19 +4943,19 @@ Examples # ------------- # # vios#sh access-lists - # Standard IP access list std_acl - # 10 deny 192.168.1.200 - # 20 deny 192.168.2.0, wildcard bits 0.0.0.255 - # Extended IP access list 110 - # 10 deny icmp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 traceroute dscp ef ttl eq 10 - # 20 deny tcp host 198.51.100.0 host 198.51.110.0 eq telnet ack - # Extended IP access list 123 - # 10 deny tcp 198.51.100.0 0.0.0.255 198.51.101.0 0.0.0.255 eq telnet ack tos 12 - # 20 deny tcp 192.0.3.0 0.0.0.255 192.0.4.0 0.0.0.255 eq www ack dscp ef ttl lt 20 - # Extended IP access list test - # 10 deny tcp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 eq www fin option traceroute ttl eq 10 - # IPv6 access list R1_TRAFFIC - # deny tcp any eq www any eq telnet ack dscp af11 sequence 10 + # ip access-list standard std_acl + # 10 deny 192.168.1.200 + # 20 deny 192.168.2.0 0.0.0.255 + # ip access-list extended 110 + # 10 deny icmp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 traceroute dscp ef ttl eq 10 + # 20 deny tcp host 198.51.100.0 host 198.51.110.0 eq telnet ack + # ip access-list extended 123 + # 10 deny tcp 198.51.100.0 0.0.0.255 198.51.101.0 0.0.0.255 eq telnet ack tos 12 + # 20 deny tcp 192.0.3.0 0.0.0.255 192.0.4.0 0.0.0.255 eq www ack dscp ef ttl lt 20 + # ip access-list extended R1_TRAFFIC + # 10 deny tcp any eq www any eq telnet ack dscp af11 + # ip access-list extended test + # 10 deny tcp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 eq www fin option traceroute ttl eq 10 - name: Override device configuration of all acls with provided configuration cisco.ios.ios_acls: @@ -4242,97 +5004,416 @@ Examples eq: 10 state: overridden - # Commands fired: - # --------------- + # Task Output + # ----------- # - # - no ip access-list standard std_acl - # - no ip access-list extended 110 - # - no ip access-list extended 123 - # - no ip access-list extended 150 - # - no ip access-list extended test - # - no ipv6 access-list R1_TRAFFIC - # - ip access-list extended 150 - # - 10 deny tcp 198.51.100.0 0.0.0.255 eq telnet 198.51.110.0 0.0.0.255 eq telnet syn dscp ef ttl eq 10 - # - ip access-list extended 110 - # - 20 deny tcp 198.51.100.0 0.0.0.255 eq telnet 198.51.110.0 0.0.0.255 eq www ack dscp ef ttl eq 10 + # before: + # - acls: + # - aces: + # - destination: + # address: 192.0.3.0 + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: icmp + # protocol_options: + # icmp: + # traceroute: true + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # eq: 10 + # - destination: + # host: 198.51.110.0 + # port_protocol: + # eq: telnet + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 20 + # source: + # host: 198.51.100.0 + # acl_type: extended + # name: '110' + # - aces: + # - destination: + # address: 198.51.101.0 + # port_protocol: + # eq: telnet + # wildcard_bits: 0.0.0.255 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 10 + # source: + # address: 198.51.100.0 + # wildcard_bits: 0.0.0.255 + # tos: + # service_value: 12 + # - destination: + # address: 192.0.4.0 + # port_protocol: + # eq: www + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 20 + # source: + # address: 192.0.3.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # lt: 20 + # acl_type: extended + # name: '123' + # - aces: + # - destination: + # any: true + # port_protocol: + # eq: telnet + # dscp: af11 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 10 + # source: + # any: true + # port_protocol: + # eq: www + # acl_type: extended + # name: R1_TRAFFIC + # - aces: + # - grant: deny + # sequence: 10 + # source: + # host: 192.168.1.200 + # - grant: deny + # sequence: 20 + # source: + # address: 192.168.2.0 + # wildcard_bits: 0.0.0.255 + # acl_type: standard + # name: std_acl + # - aces: + # - destination: + # address: 192.0.3.0 + # port_protocol: + # eq: www + # wildcard_bits: 0.0.0.255 + # grant: deny + # option: + # traceroute: true + # protocol: tcp + # protocol_options: + # tcp: + # fin: true + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # eq: 10 + # acl_type: extended + # name: test + # afi: ipv4 + # commands: + # - ip access-list extended 110 + # - no 20 deny tcp host 198.51.100.0 host 198.51.110.0 eq telnet ack + # - no 10 deny icmp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 traceroute dscp ef ttl eq 10 + # - 20 deny tcp 198.51.100.0 0.0.0.255 eq telnet 198.51.110.0 0.0.0.255 eq www ack dscp ef ttl eq 10 + # - ip access-list extended 150 + # - 10 deny tcp 198.51.100.0 0.0.0.255 eq telnet 198.51.110.0 0.0.0.255 eq telnet syn dscp ef ttl eq 10 + # - no ip access-list extended 123 + # - no ip access-list extended R1_TRAFFIC + # - no ip access-list standard std_acl + # - no ip access-list extended test + # after: + # - acls: + # - aces: + # - destination: + # address: 198.51.110.0 + # port_protocol: + # eq: www + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 20 + # source: + # address: 198.51.100.0 + # port_protocol: + # eq: telnet + # wildcard_bits: 0.0.0.255 + # ttl: + # eq: 10 + # acl_type: extended + # name: '110' + # - aces: + # - destination: + # address: 198.51.110.0 + # port_protocol: + # eq: telnet + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # syn: true + # sequence: 10 + # source: + # address: 198.51.100.0 + # port_protocol: + # eq: telnet + # wildcard_bits: 0.0.0.255 + # ttl: + # eq: 10 + # acl_type: extended + # name: '150' + # afi: ipv4 # After state: # ------------- # - # vios#sh access-lists - # Extended IP access list 110 - # 20 deny tcp 198.51.100.0 0.0.0.255 eq telnet 198.51.110.0 0.0.0.255 eq www ack dscp ef ttl eq 10 - # Extended IP access list 150 - # 10 deny tcp 198.51.100.0 0.0.0.255 eq telnet 198.51.110.0 0.0.0.255 eq telnet syn dscp ef ttl eq 10 + # vios#sh running-config | section access-list + # ip access-list extended 110 + # 20 deny tcp 198.51.100.0 0.0.0.255 eq telnet 198.51.110.0 0.0.0.255 eq www ack dscp ef ttl eq 10 + # ip access-list extended 150 + # 10 deny tcp 198.51.100.0 0.0.0.255 eq telnet 198.51.110.0 0.0.0.255 eq telnet syn dscp ef ttl eq 10 + - # Using Deleted + # Using deleted - delete ACL(s) # Before state: # ------------- # # vios#sh access-lists - # Standard IP access list std_acl - # 10 deny 192.168.1.200 - # 20 deny 192.168.2.0, wildcard bits 0.0.0.255 - # Extended IP access list 110 - # 10 deny icmp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 traceroute dscp ef ttl eq 10 - # 20 deny tcp host 198.51.100.0 host 198.51.110.0 eq telnet ack - # Extended IP access list 123 - # 10 deny tcp 198.51.100.0 0.0.0.255 198.51.101.0 0.0.0.255 eq telnet ack tos 12 - # 20 deny tcp 192.0.3.0 0.0.0.255 192.0.4.0 0.0.0.255 eq www ack dscp ef ttl lt 20 - # Extended IP access list test - # 10 deny tcp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 eq www fin option traceroute ttl eq 10 - # IPv6 access list R1_TRAFFIC - # deny tcp any eq www any eq telnet ack dscp af11 sequence 10 + # ip access-list standard std_acl + # 10 deny 192.168.1.200 + # 20 deny 192.168.2.0 0.0.0.255 + # ip access-list extended 110 + # 10 deny icmp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 traceroute dscp ef ttl eq 10 + # 20 deny tcp host 198.51.100.0 host 198.51.110.0 eq telnet ack + # ip access-list extended 123 + # 10 deny tcp 198.51.100.0 0.0.0.255 198.51.101.0 0.0.0.255 eq telnet ack tos 12 + # 20 deny tcp 192.0.3.0 0.0.0.255 192.0.4.0 0.0.0.255 eq www ack dscp ef ttl lt 20 + # ip access-list extended extended_acl_1 + # 10 deny tcp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 eq www fin option traceroute ttl eq 10 - name: "Delete ACLs (Note: This won't delete the all configured ACLs)" cisco.ios.ios_acls: config: - afi: ipv4 acls: - - name: test + - name: extended_acl_1 acl_type: extended - name: 110 - - afi: ipv6 - acls: - - name: R1_TRAFFIC state: deleted - # Commands fired: - # --------------- + # Task Output + # ----------- # - # - no ip access-list extended test - # - no ip access-list extended 110 - # - no ipv6 access-list R1_TRAFFIC + # before: + # - acls: + # - aces: + # - destination: + # address: 192.0.3.0 + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: icmp + # protocol_options: + # icmp: + # traceroute: true + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # eq: 10 + # - destination: + # host: 198.51.110.0 + # port_protocol: + # eq: telnet + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 20 + # source: + # host: 198.51.100.0 + # acl_type: extended + # name: '110' + # - aces: + # - destination: + # address: 198.51.101.0 + # port_protocol: + # eq: telnet + # wildcard_bits: 0.0.0.255 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 10 + # source: + # address: 198.51.100.0 + # wildcard_bits: 0.0.0.255 + # tos: + # service_value: 12 + # - destination: + # address: 192.0.4.0 + # port_protocol: + # eq: www + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 20 + # source: + # address: 192.0.3.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # lt: 20 + # acl_type: extended + # name: '123' + # - aces: + # - grant: deny + # sequence: 10 + # source: + # host: 192.168.1.200 + # - grant: deny + # sequence: 20 + # source: + # address: 192.168.2.0 + # wildcard_bits: 0.0.0.255 + # acl_type: standard + # name: std_acl + # - aces: + # - destination: + # address: 192.0.3.0 + # port_protocol: + # eq: www + # wildcard_bits: 0.0.0.255 + # grant: deny + # option: + # traceroute: true + # protocol: tcp + # protocol_options: + # tcp: + # fin: true + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # eq: 10 + # acl_type: extended + # name: extended_acl_1 + # afi: ipv4 + # commands: + # - no ip access-list extended 110 + # - no ip access-list extended extended_acl_1 + # after: + # - acls: + # - aces: + # - destination: + # address: 198.51.101.0 + # port_protocol: + # eq: telnet + # wildcard_bits: 0.0.0.255 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 10 + # source: + # address: 198.51.100.0 + # wildcard_bits: 0.0.0.255 + # tos: + # service_value: 12 + # - destination: + # address: 192.0.4.0 + # port_protocol: + # eq: www + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 20 + # source: + # address: 192.0.3.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # lt: 20 + # acl_type: extended + # name: '123' + # - aces: + # - grant: deny + # sequence: 10 + # source: + # host: 192.168.1.200 + # - grant: deny + # sequence: 20 + # source: + # address: 192.168.2.0 + # wildcard_bits: 0.0.0.255 + # acl_type: standard + # name: std_acl + # afi: ipv4 # After state: # ------------- # - # vios#sh access-lists - # Standard IP access list std_acl + # vios#sh running-config | section access-list + # ip access-list standard std_acl # 10 deny 192.168.1.200 - # 20 deny 192.168.2.0, wildcard bits 0.0.0.255 - # Extended IP access list 123 + # 20 deny 192.168.2.0 0.0.0.255 + # ip access-list extended 123 # 10 deny tcp 198.51.100.0 0.0.0.255 198.51.101.0 0.0.0.255 eq telnet ack tos 12 # 20 deny tcp 192.0.3.0 0.0.0.255 192.0.4.0 0.0.0.255 eq www ack dscp ef ttl lt 20 + # Using deleted - delete ACLs based on AFI + # Before state: # ------------- # - # vios#sh access-lists - # Standard IP access list std_acl - # 10 deny 192.168.1.200 - # 20 deny 192.168.2.0, wildcard bits 0.0.0.255 - # Extended IP access list 110 - # 10 deny icmp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 traceroute dscp ef ttl eq 10 - # 20 deny tcp host 198.51.100.0 host 198.51.110.0 eq telnet ack - # Extended IP access list 123 - # 10 deny tcp 198.51.100.0 0.0.0.255 198.51.101.0 0.0.0.255 eq telnet ack tos 12 - # 20 deny tcp 192.0.3.0 0.0.0.255 192.0.4.0 0.0.0.255 eq www ack dscp ef ttl lt 20 - # Extended IP access list test - # 10 deny tcp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 eq www fin option traceroute ttl eq 10 - # IPv6 access list R1_TRAFFIC - # deny tcp any eq www any eq telnet ack dscp af11 sequence 10 + # vios#sh running-config | section access-list + # ip access-list standard std_acl + # 10 deny 192.168.1.200 + # 20 deny 192.168.2.0 0.0.0.255 + # ip access-list extended 110 + # 10 deny icmp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 traceroute dscp ef ttl eq 10 + # 20 deny tcp host 198.51.100.0 host 198.51.110.0 eq telnet ack + # ip access-list extended 123 + # 10 deny tcp 198.51.100.0 0.0.0.255 198.51.101.0 0.0.0.255 eq telnet ack tos 12 + # 20 deny tcp 192.0.3.0 0.0.0.255 192.0.4.0 0.0.0.255 eq www ack dscp ef ttl lt 20 + # ip access-list extended test + # 10 deny tcp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 eq www fin option traceroute ttl eq 10 + # ipv6 access-list R1_TRAFFIC + # sequence 10 deny tcp any eq www any eq telnet ack dscp af11 - name: "Delete ACLs based on AFI (Note: This won't delete the all configured ACLs)" cisco.ios.ios_acls: @@ -4340,245 +5421,478 @@ Examples - afi: ipv4 state: deleted - # Commands fired: - # --------------- + # Task Output + # ----------- # - # - no ip access-list standard std_acl - # - no ip access-list extended test - # - no ip access-list extended 110 - # - no ip access-list extended 123 + # before: + # - acls: + # - aces: + # - destination: + # address: 192.0.3.0 + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: icmp + # protocol_options: + # icmp: + # traceroute: true + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # eq: 10 + # - destination: + # host: 198.51.110.0 + # port_protocol: + # eq: telnet + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 20 + # source: + # host: 198.51.100.0 + # acl_type: extended + # name: '110' + # - aces: + # - destination: + # address: 198.51.101.0 + # port_protocol: + # eq: telnet + # wildcard_bits: 0.0.0.255 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 10 + # source: + # address: 198.51.100.0 + # wildcard_bits: 0.0.0.255 + # tos: + # service_value: 12 + # - destination: + # address: 192.0.4.0 + # port_protocol: + # eq: www + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 20 + # source: + # address: 192.0.3.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # lt: 20 + # acl_type: extended + # name: '123' + # - aces: + # - grant: deny + # sequence: 10 + # source: + # host: 192.168.1.200 + # - grant: deny + # sequence: 20 + # source: + # address: 192.168.2.0 + # wildcard_bits: 0.0.0.255 + # acl_type: standard + # name: std_acl + # - aces: + # - destination: + # address: 192.0.3.0 + # port_protocol: + # eq: www + # wildcard_bits: 0.0.0.255 + # grant: deny + # option: + # traceroute: true + # protocol: tcp + # protocol_options: + # tcp: + # fin: true + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # eq: 10 + # acl_type: extended + # name: test + # afi: ipv4 + # - acls: + # - aces: + # - destination: + # any: true + # port_protocol: + # eq: telnet + # dscp: af11 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 10 + # source: + # any: true + # port_protocol: + # eq: www + # name: R1_TRAFFIC + # afi: ipv6 + # commands: + # - no ip access-list extended 110 + # - no ip access-list extended 123 + # - no ip access-list standard std_acl + # - no ip access-list extended test + # after: + # - acls: + # - aces: + # - destination: + # any: true + # port_protocol: + # eq: telnet + # dscp: af11 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 10 + # source: + # any: true + # port_protocol: + # eq: www + # name: R1_TRAFFIC + # afi: ipv6 # After state: # ------------- # - # vios#sh access-lists - # IPv6 access list R1_TRAFFIC - # deny tcp any eq www any eq telnet ack dscp af11 sequence 10 + # vios#sh running-config | section access-list + # ipv6 access-list R1_TRAFFIC + # sequence 10 deny tcp any eq www any eq telnet ack dscp af11 + - # Using Deleted without any config passed - #"(NOTE: This will delete all of configured ACLs)" + # Using deleted - delete all ACLs # Before state: # ------------- # # vios#sh access-lists - # Standard IP access list std_acl - # 10 deny 192.168.1.200 - # 20 deny 192.168.2.0, wildcard bits 0.0.0.255 - # Extended IP access list 110 - # 10 deny icmp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 traceroute dscp ef ttl eq 10 - # 20 deny tcp host 198.51.100.0 host 198.51.110.0 eq telnet ack - # Extended IP access list 123 - # 10 deny tcp 198.51.100.0 0.0.0.255 198.51.101.0 0.0.0.255 eq telnet ack tos 12 - # 20 deny tcp 192.0.3.0 0.0.0.255 192.0.4.0 0.0.0.255 eq www ack dscp ef ttl lt 20 - # Extended IP access list test - # 10 deny tcp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 eq www fin option traceroute ttl eq 10 - # IPv6 access list R1_TRAFFIC - # deny tcp any eq www any eq telnet ack dscp af11 sequence 10 + # ip access-list standard std_acl + # 10 deny 192.168.1.200 + # 20 deny 192.168.2.0 0.0.0.255 + # ip access-list extended 110 + # 10 deny icmp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 traceroute dscp ef ttl eq 10 + # 20 deny tcp host 198.51.100.0 host 198.51.110.0 eq telnet ack + # ip access-list extended 123 + # 10 deny tcp 198.51.100.0 0.0.0.255 198.51.101.0 0.0.0.255 eq telnet ack tos 12 + # 20 deny tcp 192.0.3.0 0.0.0.255 192.0.4.0 0.0.0.255 eq www ack dscp ef ttl lt 20 + # ip access-list extended test + # 10 deny tcp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 eq www fin option traceroute ttl eq 10 + # ipv6 access-list R1_TRAFFIC + # sequence 10 deny tcp any eq www any eq telnet ack dscp af11 - - name: - "Delete ALL of configured ACLs (Note: This WILL delete the all configured - ACLs)" + - name: Delete ALL of configured ACLs cisco.ios.ios_acls: state: deleted - # Commands fired: - # --------------- + # Task Output + # ----------- # - # - no ip access-list extended test - # - no ip access-list extended 110 - # - no ip access-list extended 123 - # - no ip access-list extended test - # - no ipv6 access-list R1_TRAFFIC + # before: + # - acls: + # - aces: + # - destination: + # address: 192.0.3.0 + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: icmp + # protocol_options: + # icmp: + # traceroute: true + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # eq: 10 + # - destination: + # host: 198.51.110.0 + # port_protocol: + # eq: telnet + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 20 + # source: + # host: 198.51.100.0 + # acl_type: extended + # name: '110' + # - aces: + # - destination: + # address: 198.51.101.0 + # port_protocol: + # eq: telnet + # wildcard_bits: 0.0.0.255 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 10 + # source: + # address: 198.51.100.0 + # wildcard_bits: 0.0.0.255 + # tos: + # service_value: 12 + # - destination: + # address: 192.0.4.0 + # port_protocol: + # eq: www + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 20 + # source: + # address: 192.0.3.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # lt: 20 + # acl_type: extended + # name: '123' + # - aces: + # - grant: deny + # sequence: 10 + # source: + # host: 192.168.1.200 + # - grant: deny + # sequence: 20 + # source: + # address: 192.168.2.0 + # wildcard_bits: 0.0.0.255 + # acl_type: standard + # name: std_acl + # - aces: + # - destination: + # address: 192.0.3.0 + # port_protocol: + # eq: www + # wildcard_bits: 0.0.0.255 + # grant: deny + # option: + # traceroute: true + # protocol: tcp + # protocol_options: + # tcp: + # fin: true + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # eq: 10 + # acl_type: extended + # name: test + # afi: ipv4 + # - acls: + # - aces: + # - destination: + # any: true + # port_protocol: + # eq: telnet + # dscp: af11 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 10 + # source: + # any: true + # port_protocol: + # eq: www + # name: R1_TRAFFIC + # afi: ipv6 + # commands: + # - no ip access-list extended test + # - no ip access-list extended 110 + # - no ip access-list extended 123 + # - no ip access-list extended test + # - no ipv6 access-list R1_TRAFFIC + # after: [] # After state: # ------------- # - # vios#sh access-lists + # vios#sh running-config | section access-list - # Using Gathered + + # Using gathered # Before state: # ------------- # # vios#sh access-lists - # Standard IP access list std_acl + # ip access-list standard std_acl # 10 deny 192.168.1.200 - # 20 deny 192.168.2.0, wildcard bits 0.0.0.255 - # Extended IP access list 110 + # 20 deny 192.168.2.0 0.0.0.255 + # ip access-list extended 110 # 10 deny icmp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 traceroute dscp ef ttl eq 10 # 20 deny tcp host 198.51.100.0 host 198.51.110.0 eq telnet ack - # Extended IP access list 123 + # ip access-list extended 123 # 10 deny tcp 198.51.100.0 0.0.0.255 198.51.101.0 0.0.0.255 eq telnet ack tos 12 # 20 deny tcp 192.0.3.0 0.0.0.255 192.0.4.0 0.0.0.255 eq www ack dscp ef ttl lt 20 - # Extended IP access list test + # ip access-list extended test # 10 deny tcp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 eq www fin option traceroute ttl eq 10 - # IPv6 access list R1_TRAFFIC - # deny tcp any eq www any eq telnet ack dscp af11 sequence 10 + # ipv6 access-list R1_TRAFFIC + # sequence 10 deny tcp any eq www any eq telnet ack dscp af11 - - name: Gather listed acls with provided configurations + - name: Gather ACLs configuration from target device cisco.ios.ios_acls: - config: state: gathered # Module Execution Result: # ------------------------ # - # "gathered": [ - # { - # "acls": [ - # { - # "aces": [ - # { - # "destination": { - # "address": "192.0.3.0", - # "wildcard_bits": "0.0.0.255" - # }, - # "dscp": "ef", - # "grant": "deny", - # "protocol_options": { - # "icmp": { - # "echo": true - # } - # }, - # "sequence": 10, - # "source": { - # "address": "192.0.2.0", - # "wildcard_bits": "0.0.0.255" - # }, - # "ttl": { - # "eq": 10 - # } - # } - # ], - # "acl_type": "extended", - # "name": "110" - # }, - # { - # "aces": [ - # { - # "destination": { - # "address": "198.51.101.0", - # "port_protocol": { - # "eq": "telnet" - # }, - # "wildcard_bits": "0.0.0.255" - # }, - # "grant": "deny", - # "protocol_options": { - # "tcp": { - # "ack": true - # } - # }, - # "sequence": 10, - # "source": { - # "address": "198.51.100.0", - # "wildcard_bits": "0.0.0.255" - # }, - # "tos": { - # "service_value": 12 - # } - # }, - # { - # "destination": { - # "address": "192.0.4.0", - # "port_protocol": { - # "eq": "www" - # }, - # "wildcard_bits": "0.0.0.255" - # }, - # "dscp": "ef", - # "grant": "deny", - # "protocol_options": { - # "tcp": { - # "ack": true - # } - # }, - # "sequence": 20, - # "source": { - # "address": "192.0.3.0", - # "wildcard_bits": "0.0.0.255" - # }, - # "ttl": { - # "lt": 20 - # } - # } - # ], - # "acl_type": "extended", - # "name": "123" - # }, - # { - # "aces": [ - # { - # "destination": { - # "address": "192.0.3.0", - # "port_protocol": { - # "eq": "www" - # }, - # "wildcard_bits": "0.0.0.255" - # }, - # "grant": "deny", - # "option": { - # "traceroute": true - # }, - # "protocol_options": { - # "tcp": { - # "fin": true - # } - # }, - # "sequence": 10, - # "source": { - # "address": "192.0.2.0", - # "wildcard_bits": "0.0.0.255" - # }, - # "ttl": { - # "eq": 10 - # } - # } - # ], - # "acl_type": "extended", - # "name": "test_acl" - # } - # ], - # "afi": "ipv4" - # }, - # { - # "acls": [ - # { - # "aces": [ - # { - # "destination": { - # "any": true, - # "port_protocol": { - # "eq": "telnet" - # } - # }, - # "dscp": "af11", - # "grant": "deny", - # "protocol_options": { - # "tcp": { - # "ack": true - # } - # }, - # "sequence": 10, - # "source": { - # "any": true, - # "port_protocol": { - # "eq": "www" - # } - # } - # } - # ], - # "name": "R1_TRAFFIC" - # } - # ], - # "afi": "ipv6" - # } - # ] + # before: + # - acls: + # - aces: + # - destination: + # address: 192.0.3.0 + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: icmp + # protocol_options: + # icmp: + # traceroute: true + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # eq: 10 + # - destination: + # host: 198.51.110.0 + # port_protocol: + # eq: telnet + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 20 + # source: + # host: 198.51.100.0 + # acl_type: extended + # name: '110' + # - aces: + # - destination: + # address: 198.51.101.0 + # port_protocol: + # eq: telnet + # wildcard_bits: 0.0.0.255 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 10 + # source: + # address: 198.51.100.0 + # wildcard_bits: 0.0.0.255 + # tos: + # service_value: 12 + # - destination: + # address: 192.0.4.0 + # port_protocol: + # eq: www + # wildcard_bits: 0.0.0.255 + # dscp: ef + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 20 + # source: + # address: 192.0.3.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # lt: 20 + # acl_type: extended + # name: '123' + # - aces: + # - grant: deny + # sequence: 10 + # source: + # host: 192.168.1.200 + # - grant: deny + # sequence: 20 + # source: + # address: 192.168.2.0 + # wildcard_bits: 0.0.0.255 + # acl_type: standard + # name: std_acl + # - aces: + # - destination: + # address: 192.0.3.0 + # port_protocol: + # eq: www + # wildcard_bits: 0.0.0.255 + # grant: deny + # option: + # traceroute: true + # protocol: tcp + # protocol_options: + # tcp: + # fin: true + # sequence: 10 + # source: + # address: 192.0.2.0 + # wildcard_bits: 0.0.0.255 + # ttl: + # eq: 10 + # acl_type: extended + # name: test + # afi: ipv4 + # - acls: + # - aces: + # - destination: + # any: true + # port_protocol: + # eq: telnet + # dscp: af11 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 10 + # source: + # any: true + # port_protocol: + # eq: www + # name: R1_TRAFFIC + # afi: ipv6 - # Using Rendered + # Using rendered - - name: Rendered the provided configuration with the existing running configuration + - name: Render the provided configuration into platform specific configuration lines cisco.ios.ios_acls: config: - afi: ipv4 @@ -4625,12 +5939,11 @@ Examples # Module Execution Result: # ------------------------ # - # "rendered": [ - # "ip access-list extended 110", - # "10 deny tcp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 eq www syn dscp ef ttl eq 10", - # "ip access-list extended 150", - # "deny tcp 198.51.100.0 0.0.0.255 eq telnet 198.51.110.0 0.0.0.255 eq telnet syn dscp ef ttl eq 10" - # ] + # rendered: + # - ip access-list extended 110 + # - 10 deny tcp 192.0.2.0 0.0.0.255 192.0.3.0 0.0.0.255 eq www syn dscp ef ttl eq 10 + # - ip access-list extended 150 + # - deny tcp 198.51.100.0 0.0.0.255 eq telnet 198.51.110.0 0.0.0.255 eq telnet syn dscp ef ttl eq 10 # Using Parsed @@ -4648,39 +5961,26 @@ Examples # Module Execution Result: # ------------------------ # - # "parsed": [ - # { - # "acls": [ - # { - # "aces": [ - # { - # "destination": { - # "any": true, - # "port_protocol": { - # "eq": "telnet" - # } - # }, - # "dscp": "af11", - # "grant": "deny", - # "protocol_options": { - # "tcp": { - # "ack": true - # } - # }, - # "source": { - # "any": true, - # "port_protocol": { - # "eq": "www" - # } - # } - # } - # ], - # "name": "R1_TRAFFIC" - # } - # ], - # "afi": "ipv6" - # } - # ] + # parsed: + # - acls: + # - aces: + # - destination: + # any: true + # port_protocol: + # eq: telnet + # dscp: af11 + # grant: deny + # protocol: tcp + # protocol_options: + # tcp: + # ack: true + # sequence: 10 + # source: + # any: true + # port_protocol: + # eq: www + # name: R1_TRAFFIC + # afi: ipv6 diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_banner_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_banner_module.rst index 372179412..75e1affa7 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_banner_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_banner_module.rst @@ -143,7 +143,7 @@ Examples - name: Configure banner from file cisco.ios.ios_banner: banner: motd - text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}" # Use unix formatted text files (LF not CRLF) to avoid idempotency issues. + text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}" # Use unix formatted text files (LF not CRLF) to avoid idempotency issues. state: present - name: Configure the login banner using delimiter diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_bgp_address_family_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_bgp_address_family_module.rst index b6a4100bc..25fb233ac 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_bgp_address_family_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_bgp_address_family_module.rst @@ -70,6 +70,66 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="6"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>advertise</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 path advertise/export to other address-family</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <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> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>l2vpn</li> + </ul> + </td> + <td> + <div>Address family for VRF advertise/export</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <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>evpn</li> + </ul> + </td> + <td> + <div>Advertise/export prefixes to address family</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="6"> + <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"> @@ -3101,7 +3161,7 @@ Parameters <b>number</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: purple">string</span> </div> </td> <td> @@ -3327,29 +3387,6 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="5"> <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>Disable the next hop calculation for this neighbor</div> - <div>This option is DEPRECATED and is replaced with nexthop_self which accepts dict as input this attribute will be removed after 2023-06-01.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="5"> - <div class="ansibleOptionAnchor" id="parameter-"></div> <b>next_hop_unchanged</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -4049,7 +4086,7 @@ Parameters <b>remote_as</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: purple">string</span> </div> </td> <td> diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_bgp_global_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_bgp_global_module.rst index b753c10fe..ad461f776 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_bgp_global_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_bgp_global_module.rst @@ -9407,6 +9407,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>gathered</li> @@ -9416,10 +9417,11 @@ Parameters </td> <td> <div>The state the configuration should be left in</div> + <div>The module have declaratively similar behavior for replaced and overridden state.</div> <div>The states <em>rendered</em>, <em>gathered</em> and <em>parsed</em> does not perform any change on the device.</div> <div>The state <em>rendered</em> will transform the configuration in <code>config</code> option to platform specific CLI commands which will be returned in the <em>rendered</em> key within the result. For state <em>rendered</em> active connection to remote host is not required.</div> <div>The state <em>gathered</em> will fetch the running configuration from device and transform it into structured data in the format as per the resource module argspec and the value is returned in the <em>gathered</em> key within the result.</div> - <div>The state <em>parsed</em> reads the configuration from <code>running_config</code> option and transforms it into JSON format as per the resource module parameters and the value is returned in the <em>parsed</em> key within the result. The value of <code>running_config</code> option should be the same format as the output of command <em>show running-config | include ip route|ipv6 route</em> executed on device. For state <em>parsed</em> active connection to remote host is not required.</div> + <div>The state <em>parsed</em> reads the configuration from <code>running_config</code> option and transforms it into JSON format as per the resource module parameters and the value is returned in the <em>parsed</em> key within the result. The value of <code>running_config</code> option should be the same format as the output of command <em>show running-config | section ^router bgp</em> executed on device. For state <em>parsed</em> active connection to remote host is not required.</div> </td> </tr> </table> @@ -9662,6 +9664,7 @@ Examples # networks: # - address: 192.0.2.2 # - address: 192.0.2.3 + # # commands: # - router bgp 65000 # - no bgp bestpath compare-routerid diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_command_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_command_module.rst index 305641a9a..51437902e 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_command_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_command_module.rst @@ -141,7 +141,7 @@ Examples - name: Run show version on remote devices cisco.ios.ios_command: - commands: show version' + commands: show version # output- diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_evpn_evi_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_evpn_evi_module.rst new file mode 100644 index 000000000..9c19c8cdf --- /dev/null +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_evpn_evi_module.rst @@ -0,0 +1,791 @@ +.. _cisco.ios.ios_evpn_evi_module: + + +********************** +cisco.ios.ios_evpn_evi +********************** + +**Resource module to configure L2VPN EVPN EVI.** + + +Version added: 5.3.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module provides declarative management of L2VPN EVPN EVI on Cisco IOS network devices. + + + + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="4">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="4"> + <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 L2VPN Ethernet Virtual Private Network (EVPN) EVI configuration</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>default_gateway</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>Default Gateway parameters</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>advertise</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 Default Gateway MAC/IP routes</div> + </td> + </tr> + <tr> + <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>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 advertisement of Default Gateway MAC/IP routes</div> + </td> + </tr> + <tr> + <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>enable</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 advertisement of Default Gateway MAC/IP routes</div> + </td> + </tr> + + + <tr> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>encapsulation</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>vxlan</b> ←</div></li> + </ul> + </td> + <td> + <div>EVPN encapsulation type</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>evi</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>EVPN instance value</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>ip</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>IP parameters</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>local_learning</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>IP local learning</div> + </td> + </tr> + <tr> + <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>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 IP local learning</div> + </td> + </tr> + <tr> + <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>enable</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 IP local learning</div> + </td> + </tr> + + + <tr> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>replication_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>ingress</li> + <li>static</li> + </ul> + </td> + <td> + <div>Method for replicating BUM traffic</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>route_distinguisher</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>EVPN Route Distinguisher</div> + </td> + </tr> + + <tr> + <td colspan="4"> + <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 IOS device by executing the command <b>sh running-config nve | section ^l2vpn evpn$</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="4"> + <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 the configuration should be left in</div> + </td> + </tr> + </table> + <br/> + + +Notes +----- + +.. note:: + - Tested against Cisco IOS device with Version 17.13.01 on Cat9k on CML. + - This module works with connection ``network_cli``. See https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html + + + +Examples +-------- + +.. code-block:: yaml + + # Using state merged + + # Before state: + # ------------- + # l2vpn evpn instance 101 vlan-based + # encapsulation vxlan + # replication-type static + # ! + # l2vpn evpn instance 102 vlan-based + # encapsulation vxlan + # replication-type ingress + # ! + # l2vpn evpn instance 201 vlan-based + # encapsulation vxlan + # replication-type static + # ! + # l2vpn evpn instance 202 vlan-based + # encapsulation vxlan + # replication-type ingress + + # - name: Merge provided configuration with device configuration + # cisco.ios.ios_evpn_evi: + # config: + # - evi: 101 + # replication_type: ingress + # route_distinguisher: '1:1' + # default_gateway: + # advertise: + # enable: False + # ip: + # local_learning: + # enable: True + # + # - evi: 202 + # replication_type: static + # default_gateway: + # advertise: + # enable: True + # ip: + # local_learning: + # disable: True + # state: merged + + # Commands Fired: + # --------------- + # "commands": [ + # "l2vpn evpn instance 101 vlan-based", + # "ip local-learning enable", + # "replication-type ingress", + # "rd 1:1", + # "l2vpn evpn instance 202 vlan-based", + # "default-gateway advertise enable", + # "ip local-learning disable", + # "replication-type static" + # ], + + # After state: + # ------------ + # l2vpn evpn instance 101 vlan-based + # encapsulation vxlan + # rd 1:1 + # replication-type ingress + # ip local-learning enable + # ! + # l2vpn evpn instance 102 vlan-based + # encapsulation vxlan + # replication-type ingress + # ! + # l2vpn evpn instance 201 vlan-based + # encapsulation vxlan + # replication-type static + # ! + # l2vpn evpn instance 202 vlan-based + # encapsulation vxlan + # replication-type static + # ip local-learning disable + # default-gateway advertise enable + + + # Using state replaced + + # Before state: + # ------------- + # l2vpn evpn instance 101 vlan-based + # encapsulation vxlan + # rd 1:1 + # replication-type ingress + # ip local-learning enable + # ! + # l2vpn evpn instance 102 vlan-based + # encapsulation vxlan + # replication-type ingress + # ! + # l2vpn evpn instance 201 vlan-based + # encapsulation vxlan + # replication-type static + # ! + # l2vpn evpn instance 202 vlan-based + # encapsulation vxlan + # replication-type static + # ip local-learning disable + # default-gateway advertise enable + + # - name: Replaces the device configuration with the provided configuration + # cisco.ios.ios_evpn_evi: + # config: + # - evi: 101 + # replication_type: ingress + # default_gateway: + # advertise: + # enable: True + # - evi: 202 + # replication_type: ingress + # state: replaced + + # Commands Fired: + # --------------- + # "commands": [ + # "l2vpn evpn instance 101 vlan-based", + # "default-gateway advertise enable", + # "no ip local-learning enable", + # "no rd 1:1", + # "l2vpn evpn instance 202 vlan-based", + # "no default-gateway advertise enable", + # "no ip local-learning disable", + # "replication-type ingress" + # ], + + # After state: + # ------------ + # l2vpn evpn instance 101 vlan-based + # encapsulation vxlan + # replication-type ingress + # default-gateway advertise enable + # ! + # l2vpn evpn instance 102 vlan-based + # encapsulation vxlan + # replication-type ingress + # ! + # l2vpn evpn instance 201 vlan-based + # encapsulation vxlan + # replication-type static + # ! + # l2vpn evpn instance 202 vlan-based + # encapsulation vxlan + # replication-type ingress + + # Using state overridden + + # Before state: + # ------------- + # l2vpn evpn instance 101 vlan-based + # encapsulation vxlan + # replication-type ingress + # default-gateway advertise enable + # ! + # l2vpn evpn instance 102 vlan-based + # encapsulation vxlan + # replication-type ingress + # ! + # l2vpn evpn instance 201 vlan-based + # encapsulation vxlan + # replication-type static + # ! + # l2vpn evpn instance 202 vlan-based + # encapsulation vxlan + # replication-type ingress + + # - name: Override the device configuration with provided configuration + # cisco.ios.ios_evpn_evi: + # config: + # - evi: 101 + # replication_type: ingress + # default_gateway: + # advertise: + # enable: True + # - evi: 202 + # replication_type: static + # default_gateway: + # advertise: + # enable: True + # state: overridden + + # Commands Fired: + # --------------- + # "commands": [ + # "no l2vpn evpn instance 102 vlan-based", + # "no l2vpn evpn instance 201 vlan-based", + # "l2vpn evpn instance 202 vlan-based", + # "default-gateway advertise enable", + # "replication-type static" + # ], + + # After state: + # ------------ + # l2vpn evpn instance 101 vlan-based + # encapsulation vxlan + # replication-type ingress + # default-gateway advertise enable + # ! + # l2vpn evpn instance 202 vlan-based + # encapsulation vxlan + # replication-type static + # default-gateway advertise enable + + + # Using state Deleted + + # Before state: + # ------------- + # l2vpn evpn instance 101 vlan-based + # encapsulation vxlan + # replication-type ingress + # default-gateway advertise enable + # l2vpn evpn instance 102 vlan-based + # encapsulation vxlan + # replication-type ingress + # l2vpn evpn instance 202 vlan-based + # encapsulation vxlan + # replication-type static + # default-gateway advertise enable + + # - name: "Delete the given EVI(s)" + # cisco.ios.ios_evpn_evi: + # config: + # - evi: 101 + # state: deleted + + # Commands Fired: + # --------------- + # "commands": [ + # "no l2vpn evpn instance 101 vlan-based" + # ], + + # After state: + # ------------- + # l2vpn evpn instance 102 vlan-based + # encapsulation vxlan + # replication-type ingress + # l2vpn evpn instance 202 vlan-based + # encapsulation vxlan + # replication-type static + # default-gateway advertise enable + + # Using state Deleted without any config passed + + # Before state: + # ------------- + # l2vpn evpn instance 102 vlan-based + # encapsulation vxlan + # replication-type ingress + # l2vpn evpn instance 202 vlan-based + # encapsulation vxlan + # replication-type static + # default-gateway advertise enable + + # - name: "Delete ALL EVIs" + # cisco.ios.ios_evpn_evi: + # state: deleted + + # Commands Fired: + # --------------- + # "commands": [ + # "no l2vpn evpn instance 102 vlan-based", + # "no l2vpn evpn instance 202 vlan-based" + # ], + + # After state: + # ------------- + # ! + + # Using gathered + + # Before state: + # ------------- + # + # l2vpn evpn instance 101 vlan-based + # encapsulation vxlan + # replication-type static + # ! + # l2vpn evpn instance 102 vlan-based + # encapsulation vxlan + # replication-type ingress + # ! + # l2vpn evpn instance 201 vlan-based + # encapsulation vxlan + # replication-type static + # ! + # l2vpn evpn instance 202 vlan-based + # encapsulation vxlan + # replication-type ingress + + # - name: Gather facts for evpn_evi + # cisco.ios.ios_evpn_evi: + # config: + # state: gathered + + # Task Output: + # ------------ + # + # gathered: + # - evi: 101 + # encapsulation: vxlan + # replication_type: static + # - evi: 102 + # encapsulation: vxlan + # replication_type: ingress + # - evi: 201 + # encapsulation: vxlan + # replication_type: static + # - evi: 202 + # encapsulation: vxlan + # replication_type: ingress + + # Using Rendered + + # - name: Rendered the provided configuration with the existing running configuration + # cisco.ios.ios_evpn_evi: + # config: + # - evi: 101 + # replication_type: ingress + # default_gateway: + # advertise: + # enable: True + # - evi: 202 + # replication_type: ingress + # state: rendered + + # Task Output: + # ------------ + # + # rendered: + # - l2vpn evpn instance 101 vlan-based + # - default-gateway advertise enable + # - replication-type ingress + # - l2vpn evpn instance 202 vlan-based + # - replication-type ingress + + + # Using parsed + + # File: parsed.cfg + # ---------------- + # + # l2vpn evpn instance 101 vlan-based + # encapsulation vxlan + # replication-type ingress + # default-gateway advertise enable + # ! + # l2vpn evpn instance 102 vlan-based + # encapsulation vxlan + # replication-type ingress + # ! + + # - name: Parse the commands for provided configuration + # cisco.ios.ios_evpn_evi: + # running_config: "{{ lookup('file', 'parsed.cfg') }}" + # state: parsed + + # Task Output: + # ------------ + # + # parsed: + # - evi: 101 + # encapsulation: vxlan + # replication_type: ingress + # default_gateway: + # advertise: + # enable: true + # - evi: 102 + # encapsulation: vxlan + # replication_type: ingress + + + +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;">['l2vpn evpn instance 101 vlan-based', 'encapsulation vxlan', 'replication-type ingress']</div> + </td> + </tr> + </table> + <br/><br/> + + +Status +------ + + +Authors +~~~~~~~ + +- Padmini Priyadarshini Sivaraj (@PadminiSivaraj) diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_evpn_global_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_evpn_global_module.rst new file mode 100644 index 000000000..e9b71bbbd --- /dev/null +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_evpn_global_module.rst @@ -0,0 +1,721 @@ +.. _cisco.ios.ios_evpn_global_module: + + +************************* +cisco.ios.ios_evpn_global +************************* + +**Resource module to configure L2VPN EVPN.** + + +Version added: 5.3.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module provides declarative management of L2VPN EVPN on Cisco IOS network devices. + + + + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="4">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="4"> + <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 dictionary of L2VPN Ethernet Virtual Private Network (EVPN) configuration</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>default_gateway</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>Default gateway parameters</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>advertise</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 Default Gateway MAC/IP routes</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>flooding_suppression</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>Suppress flooding of broadcast, multicast, and/or unknown unicast packets</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>address_resolution</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>Suppress flooding of Address Resolution and Neighbor Discovery Protocol packets</div> + </td> + </tr> + <tr> + <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>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 flooding suppression</div> + </td> + </tr> + + + <tr> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>ip</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>IP parameters</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>local_learning</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>IP local learning</div> + </td> + </tr> + <tr> + <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>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 IP local learning</div> + </td> + </tr> + + + <tr> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>replication_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>ingress</li> + <li>static</li> + </ul> + </td> + <td> + <div>Method for replicating BUM traffic</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>route_target</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 VPN Extended Communities</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>auto</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>Automatically set a route-target</div> + </td> + </tr> + <tr> + <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>vni</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 vni-based route-target</div> + </td> + </tr> + + + <tr> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <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>EVPN router ID</div> + </td> + </tr> + + <tr> + <td colspan="4"> + <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 IOS device by executing the command <b>sh running-config nve | section ^l2vpn evpn$</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="4"> + <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 the configuration should be left in</div> + </td> + </tr> + </table> + <br/> + + +Notes +----- + +.. note:: + - Tested against Cisco IOS device with Version 17.13.01 on Cat9k on CML. + - This module works with connection ``network_cli``. See https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html + + + +Examples +-------- + +.. code-block:: yaml + + # Using merged + + # Before state: + # ------------- + # + # Leaf-01#show running-config nve | section ^l2vpn evpn$ + # l2vpn evpn + # replication-type static + # router-id Loopback1 + # default-gateway advertise + + - name: Merge provided configuration with device configuration + cisco.ios.ios_evpn_global: + config: + replication_type: ingress + route_target: + auto: + vni: true + default_gateway: + advertise: false + ip: + local_learning: + disable: true + flooding_suppression: + address_resolution: + disable: false + state: merged + + # Task Output + # ----------- + # + # before: + # - replication_type: static + # router_id: Loopback1 + # default_gateway: + # advertise: true + # commands: + # - l2vpn evpn + # no default-gateway advertise + # replication-type ingress + # route-target auto vni + # ip local-learning disable + # after: + # - replication_type: ingress + # router_id: Loopback1 + # route_target: + # auto: + # vni: true + # ip: + # local_learning: + # disable: true + + # After state: + # ------------ + # + # Leaf-01#show running-config nve | section ^l2vpn evpn$ + # l2vpn evpn + # replication-type ingress + # router-id Loopback1 + # ip local-learning disable + # route-target auto vni + + # Using replaced + + # Before state: + # ------------- + # + # Leaf-01#show running-config nve | section ^l2vpn evpn$ + # l2vpn evpn + # replication-type ingress + # router-id Loopback1 + # ip local-learning disable + # route-target auto vni + + - name: Replaces device configuration for EVPN global with provided configuration + cisco.ios.ios_evpn_global: + config: + replication_type: static + router_id: Loopback2 + default_gateway: + advertise: true + flooding_suppression: + address_resolution: + disable: true + state: replaced + + # Task Output + # ----------- + # + # before: + # - replication_type: ingress + # router_id: Loopback1 + # route_target: + # auto: + # vni: true + # ip: + # local_learning: + # disable: true + # commands: + # - l2vpn evpn + # - default-gateway advertise + # - flooding-suppression address-resolution disable + # - no ip local-learning disable + # - replication-type static + # - no route-target auto vni + # - router-id Loopback2 + # after: + # - replication_type: ingress + # router_id: Loopback2 + # default_gateway: + # advertise: true + # flooding_suppression: + # address_resolution: + # disable: true + + # After state: + # ------------ + # + # Leaf-01#show running-config nve | section ^l2vpn evpn$ + # l2vpn evpn + # replication-type static + # flooding-suppression address-resolution disable + # router-id Loopback2 + # default-gateway advertise + + # Using Deleted + + # Before state: + # ------------- + # + # Leaf-01#show running-config nve | section ^l2vpn evpn$ + # l2vpn evpn + # replication-type static + # flooding-suppression address-resolution disable + # router-id Loopback2 + # default-gateway advertise + + - name: Delete EVPN global + cisco.ios.ios_evpn_global: + config: + state: deleted + + # before: + # - replication_type: ingress + # router_id: Loopback2 + # default_gateway: + # advertise: true + # flooding_suppression: + # address_resolution: + # disable: true + # commands: + # - no l2vpn evpn + # after: + # + + # After state: + # ------------- + # + # Leaf-01#show running-config nve | section ^l2vpn evpn$ + # + + # Using gathered + + # Before state: + # ------------- + # + # Leaf-01#show running-config nve | section ^l2vpn evpn$ + # l2vpn evpn + # replication-type ingress + # router-id Loopback1 + # ip local-learning disable + # route-target auto vni + + - name: Gather facts of l2vpn evpn + cisco.ios.ios_evpn_global: + config: + state: gathered + + # Task Output: + # ------------ + # + # gathered: + # - replication_type: ingress + # route_target: + # auto: + # vni: true + # router_id: Loopback1 + # ip: + # local_learning: + # disable: true + + # Using rendered + + - name: Render the commands for provided configuration + cisco.ios.ios_evpn_global: + config: + replication_type: static + route_target: + auto: + vni: true + state: rendered + + # Task Output: + # ------------ + # + # rendered: + # - l2vpn evpn + # - replication-type static + # - route-target auto vni + + # Using parsed + + # File: parsed.cfg + # ---------------- + # + # l2vpn evpn + # replication-type ingress + # router-id Loopback1 + # default-gateway advertise + # route-target auto vni + + - name: Parse the provided configuration + cisco.ios.ios_evpn_global: + running_config: "{{ lookup('file', 'parsed.cfg') }}" + state: parsed + + # Task Output: + # ------------ + # + # parsed: + # - replication_type: ingress + # route_target: + # auto: + # vni: true + # router_id: Loopback1 + # default_gateway: + # advertise: 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>, or <code>deleted</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>, or <code>deleted</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;">['l2vpn evpn', 'replication-type ingress', 'router_id Loopback1']</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;">['l2vpn evpn', 'replication-type static', 'route-target auto vni']</div> + </td> + </tr> + </table> + <br/><br/> + + +Status +------ + + +Authors +~~~~~~~ + +- Padmini Priyadarshini Sivaraj (@PadminiSivaraj) diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_facts_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_facts_module.rst index cfa039387..39b210f19 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_facts_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_facts_module.rst @@ -228,6 +228,21 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late <tr> <td colspan="1"> <div class="ansibleOptionAnchor" id="return-"></div> + <b>ansible_net_cpu_utilization</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 hardware is configured</td> + <td> + <div>The current CPU utilization of the device</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> <b>ansible_net_filesystems</b> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <div style="font-size: small"> diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_hostname_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_hostname_module.rst index 5044ba541..54c459188 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_hostname_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_hostname_module.rst @@ -249,7 +249,7 @@ Examples # Before state: # ------------- - #router-ios#show running-config | section ^hostname + # router-ios#show running-config | section ^hostname # hostname RouterTest # Gathered play: diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_lacp_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_lacp_module.rst index 0ad8a6917..f2e021efa 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_lacp_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_lacp_module.rst @@ -115,6 +115,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>rendered</li> <li>parsed</li> @@ -123,6 +124,7 @@ Parameters </td> <td> <div>The state the configuration should be left in</div> + <div>The module have declaratively similar behavior for replaced and overridden state.</div> <div>The states <em>rendered</em>, <em>gathered</em> and <em>parsed</em> does not perform any change on the device.</div> <div>The state <em>rendered</em> will transform the configuration in <code>config</code> option to platform specific CLI commands which will be returned in the <em>rendered</em> key within the result. For state <em>rendered</em> active connection to remote host is not required.</div> <div>The state <em>gathered</em> will fetch the running configuration from device and transform it into structured data in the format as per the resource module argspec and the value is returned in the <em>gathered</em> key within the result.</div> diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_lag_interfaces_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_lag_interfaces_module.rst index 5970f95e9..1ce28db09 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_lag_interfaces_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_lag_interfaces_module.rst @@ -238,7 +238,7 @@ Examples - name: Port-channel20 members: - member: GigabitEthernet0/3 - mode: on + mode: "on" - name: Port-channel30 members: - member: GigabitEthernet0/4 @@ -461,7 +461,7 @@ Examples # channel-group 30 mode active # Using Deleted without any config passed - #"(NOTE: This will delete all of configured LLDP module attributes)" + # "(NOTE: This will delete all of configured LLDP module attributes)" # # Before state: diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_linkagg_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_linkagg_module.rst index 599f0130a..1a3c30505 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_linkagg_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_linkagg_module.rst @@ -275,7 +275,7 @@ Examples - name: Create aggregate of linkagg definitions cisco.ios.ios_linkagg: aggregate: - - { group: 3, mode: on, members: [GigabitEthernet0/1] } + - { group: 3, mode: "on", members: [GigabitEthernet0/1] } - { group: 100, mode: passive, members: [GigabitEthernet0/2] } diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_lldp_global_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_lldp_global_module.rst index dbb09c1c8..131fa5c7a 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_lldp_global_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_lldp_global_module.rst @@ -358,6 +358,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>rendered</li> <li>gathered</li> @@ -366,6 +367,7 @@ Parameters </td> <td> <div>The state the configuration should be left in</div> + <div>The module have declaratively similar behavior for replaced and overridden state.</div> <div>The states <em>rendered</em>, <em>gathered</em> and <em>parsed</em> does not perform any change on the device.</div> <div>The state <em>rendered</em> will transform the configuration in <code>config</code> option to platform specific CLI commands which will be returned in the <em>rendered</em> key within the result. For state <em>rendered</em> active connection to remote host is not required.</div> <div>The state <em>gathered</em> will fetch the running configuration from device and transform it into structured data in the format as per the resource module argspec and the value is returned in the <em>gathered</em> key within the result.</div> @@ -438,7 +440,7 @@ Examples # lldp reinit 5 # Using Deleted without any config passed - #"(NOTE: This will delete all of configured LLDP module attributes)" + # "(NOTE: This will delete all of configured LLDP module attributes)" # Before state: # ------------- diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_logging_global_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_logging_global_module.rst index d63f8cf32..504441719 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_logging_global_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_logging_global_module.rst @@ -2490,7 +2490,7 @@ Examples # Before state: # ------------- - #router-ios#show running-config | section logging + # router-ios#show running-config | section logging # logging exception 4099 # logging message-counter log # logging userinfo diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_logging_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_logging_module.rst deleted file mode 100644 index be41b3771..000000000 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_logging_module.rst +++ /dev/null @@ -1,401 +0,0 @@ -.. _cisco.ios.ios_logging_module: - - -********************* -cisco.ios.ios_logging -********************* - -**(deprecated, removed after 2023-06-01) Manage logging on network devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2023-06-01 -:Why: Newer and updated modules released with more functionality. -:Alternative: ios_logging_global - - - -Synopsis --------- -- This module provides declarative management of logging on Cisco Ios devices. - - - - -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>aggregate</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>List of logging definitions.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>dest</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>on</li> - <li>host</li> - <li>console</li> - <li>monitor</li> - <li>buffered</li> - <li>trap</li> - </ul> - </td> - <td> - <div>Destination of the logs.</div> - <div>On dest has to be quoted as 'on' or else pyyaml will convert to True before it gets to Ansible.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>facility</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 logging facility.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>level</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>emergencies</li> - <li>alerts</li> - <li>critical</li> - <li>errors</li> - <li>warnings</li> - <li>notifications</li> - <li>informational</li> - <li>debugging</li> - </ul> - </td> - <td> - <div>Set logging severity levels.</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> - </div> - </td> - <td> - </td> - <td> - <div>The hostname or IP address of the destination.</div> - <div>Required when <em>dest=host</em>.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>size</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>Size of buffer. The acceptable value is in range from 4096 to 4294967295 bytes.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <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>present</li> - <li>absent</li> - </ul> - </td> - <td> - <div>State of the logging configuration.</div> - </td> - </tr> - - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>dest</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>on</li> - <li>host</li> - <li>console</li> - <li>monitor</li> - <li>buffered</li> - <li>trap</li> - </ul> - </td> - <td> - <div>Destination of the logs.</div> - <div>On dest has to be quoted as 'on' or else pyyaml will convert to True before it gets to Ansible.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>facility</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 logging facility.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>level</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>emergencies</li> - <li>alerts</li> - <li>critical</li> - <li>errors</li> - <li>warnings</li> - <li>notifications</li> - <li>informational</li> - <li><div style="color: blue"><b>debugging</b> ←</div></li> - </ul> - </td> - <td> - <div>Set logging severity levels.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <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>The hostname or IP address of the destination.</div> - <div>Required when <em>dest=host</em>.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-"></div> - <b>size</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>Size of buffer. The acceptable value is in range from 4096 to 4294967295 bytes.</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>present</b> ←</div></li> - <li>absent</li> - </ul> - </td> - <td> - <div>State of the logging configuration.</div> - </td> - </tr> - </table> - <br/> - - -Notes ------ - -.. note:: - - Tested against IOS 15.6 - - The 'Default System Message Logging Configuration' of the ios device like facility Local7 or logging on is not subjected to idempotency causes - - 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 host logging - cisco.ios.ios_logging: - dest: host - name: 172.16.0.1 - state: present - - - name: Remove host logging configuration - cisco.ios.ios_logging: - dest: host - name: 172.16.0.1 - state: absent - - - name: Configure console logging level and facility - cisco.ios.ios_logging: - dest: console - facility: local7 - level: debugging - state: present - - - name: Enable logging to all - cisco.ios.ios_logging: - dest: on - - - name: Configure buffer size - cisco.ios.ios_logging: - dest: buffered - size: 5000 - - - name: Configure logging using aggregate - cisco.ios.ios_logging: - aggregate: - - { dest: console, level: notifications } - - { dest: buffered, size: 9000 } - - - name: Remove logging using aggregate - cisco.ios.ios_logging: - aggregate: - - { dest: console, level: notifications } - - { dest: buffered, size: 9000 } - state: absent - - - -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>The list of configuration mode commands to send 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;">['logging facility local7', 'logging host 172.16.0.1']</div> - </td> - </tr> - </table> - <br/><br/> - - -Status ------- - - -- This module will be removed in a release after 2023-06-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_ntp_global_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_ntp_global_module.rst index 31c3df210..10d591cf9 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_ntp_global_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_ntp_global_module.rst @@ -1884,7 +1884,7 @@ Examples # Before state: # ------------- - #router-ios#show running-config | section ^ntp + # router-ios#show running-config | section ^ntp # ntp max-associations 34 # ntp logging # ntp allow mode control 4 diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_ospf_interfaces_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_ospf_interfaces_module.rst index 1c19bef92..e780288c0 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_ospf_interfaces_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_ospf_interfaces_module.rst @@ -1529,19 +1529,60 @@ Examples - name: GigabitEthernet0/1 state: deleted - # Commands Fired: - # --------------- - # - # "commands": [ - # "interface GigabitEthernet0/1", - # "no ipv6 ospf 55 area 105", - # "no ipv6 ospf adjacency stagger disable", - # "no ipv6 ospf priority 20", - # "no ipv6 ospf transmit-delay 30" - # ] + # Task Output: + # ------------ + # before: + # - name: GigabitEthernet0/0 + # - address_family: + # - adjacency: true + # afi: ipv6 + # priority: 20 + # process: + # area_id: '105' + # id: 55 + # transmit_delay: 30 + # name: GigabitEthernet0/1 + # - address_family: + # - adjacency: true + # afi: ipv4 + # cost: + # interface_cost: 30 + # priority: 40 + # process: + # area_id: '20' + # id: 10 + # ttl_security: + # hops: 50 + # set: true + # name: GigabitEthernet0/2 + # + # commands: + # - interface GigabitEthernet0/1 + # - no ipv6 ospf 55 area 105 + # - no ipv6 ospf adjacency stagger disable + # - no ipv6 ospf priority 20 + # - no ipv6 ospf transmit-delay 30 + # + # after: + # - name: GigabitEthernet0/0 + # - name: GigabitEthernet0/1 + # - address_family: + # - adjacency: true + # afi: ipv4 + # cost: + # interface_cost: 30 + # priority: 40 + # process: + # area_id: '20' + # id: 10 + # ttl_security: + # hops: 50 + # set: true + # name: GigabitEthernet0/2 + # # After state: - # ------------- + # ------------ # router-ios#sh running-config | section ^interface # interface GigabitEthernet0/0 # interface GigabitEthernet0/1 @@ -1575,22 +1616,51 @@ Examples cisco.ios.ios_ospf_interfaces: state: deleted - # Commands Fired: - # --------------- + # Task Output: + # ------------ + + # before: + # - name: GigabitEthernet0/0 + # - address_family: + # - adjacency: true + # afi: ipv6 + # priority: 20 + # process: + # area_id: '105' + # id: 55 + # transmit_delay: 30 + # name: GigabitEthernet0/1 + # - address_family: + # - adjacency: true + # afi: ipv4 + # cost: + # interface_cost: 30 + # priority: 40 + # process: + # area_id: '20' + # id: 10 + # ttl_security: + # hops: 50 + # set: true + # name: GigabitEthernet0/2 + # + # commands: + # - interface GigabitEthernet0/2 + # - no ip ospf 10 area 20 + # - no ip ospf adjacency stagger disable + # - no ip ospf cost 30 + # - no ip ospf priority 40 + # - no ip ospf ttl-security hops 50 + # - interface GigabitEthernet0/1 + # - no ipv6 ospf 55 area 105 + # - no ipv6 ospf adjacency stagger disable + # - no ipv6 ospf priority 20 + # - no ipv6 ospf transmit-delay 30 # - # "commands": [ - # "interface GigabitEthernet0/2", - # "no ip ospf 10 area 20", - # "no ip ospf adjacency stagger disable", - # "no ip ospf cost 30", - # "no ip ospf priority 40", - # "no ip ospf ttl-security hops 50", - # "interface GigabitEthernet0/1", - # "no ipv6 ospf 55 area 105", - # "no ipv6 ospf adjacency stagger disable", - # "no ipv6 ospf priority 20", - # "no ipv6 ospf transmit-delay 30" - # ] + # after: + # - name: GigabitEthernet0/0 + # - name: GigabitEthernet0/1 + # - name: GigabitEthernet0/2 # After state: # ------------- @@ -1644,29 +1714,67 @@ Examples transmit_delay: 45 state: merged - # Commands Fired: - # --------------- + # Task Output: + # ------------ + # before: [] + # + # commands: + # - interface GigabitEthernet0/1 + # - ip ospf 10 area 30 + # - ip ospf adjacency stagger disable + # - ip ospf bfd + # - ip ospf cost 5 + # - ip ospf dead-interval 5 + # - ip ospf demand-circuit ignore + # - ip ospf network broadcast + # - ip ospf priority 25 + # - ip ospf resync-timeout 10 + # - ip ospf shutdown + # - ip ospf ttl-security hops 50 + # - ipv6 ospf 35 area 45 + # - ipv6 ospf adjacency stagger disable + # - ipv6 ospf database-filter all out + # - ipv6 ospf manet peering link-metrics 10 + # - ipv6 ospf priority 55 + # - ipv6 ospf transmit-delay 45 # - # "commands": [ - # "interface GigabitEthernet0/1", - # "ip ospf 10 area 30", - # "ip ospf adjacency stagger disable", - # "ip ospf bfd", - # "ip ospf cost 5", - # "ip ospf dead-interval 5", - # "ip ospf demand-circuit ignore", - # "ip ospf network broadcast", - # "ip ospf priority 25", - # "ip ospf resync-timeout 10", - # "ip ospf shutdown", - # "ip ospf ttl-security hops 50", - # "ipv6 ospf 35 area 45", - # "ipv6 ospf adjacency stagger disable", - # "ipv6 ospf database-filter all out", - # "ipv6 ospf manet peering link-metrics 10", - # "ipv6 ospf priority 55", - # "ipv6 ospf transmit-delay 45" - # ] + # after: + # - name: GigabitEthernet0/0 + # - address_family: + # - adjacency: true + # afi: ipv4 + # bfd: true + # cost: + # interface_cost: 5 + # dead_interval: + # time: 5 + # demand_circuit: + # enable: true + # ignore: true + # network: + # broadcast: true + # priority: 25 + # process: + # area_id: '30' + # id: 10 + # resync_timeout: 10 + # shutdown: true + # ttl_security: + # hops: 50 + # set: true + # - adjacency: true + # afi: ipv6 + # database_filter: true + # manet: + # link_metrics: + # cost_threshold: 10 + # priority: 55 + # process: + # area_id: '45' + # id: 35 + # transmit_delay: 45 + # name: GigabitEthernet0/1 + # - name: GigabitEthernet0/2 # After state: # ------------- @@ -1720,7 +1828,7 @@ Examples # ipv6 ospf manet peering link-metrics 10 # interface GigabitEthernet0/2 - - name: Override provided OSPF Interfaces configuration + - name: Override running config with provided OSPF Interfaces configuration cisco.ios.ios_ospf_interfaces: config: - name: GigabitEthernet0/1 @@ -1746,35 +1854,97 @@ Examples hops: 50 state: overridden - # Commands Fired: - # --------------- + # Task Output: + # ------------ + # + # before: + # - name: GigabitEthernet0/0 + # - address_family: + # - adjacency: true + # afi: ipv4 + # bfd: true + # cost: + # interface_cost: 5 + # dead_interval: + # time: 5 + # demand_circuit: + # enable: true + # ignore: true + # network: + # broadcast: true + # priority: 25 + # process: + # area_id: '30' + # id: 10 + # resync_timeout: 10 + # shutdown: true + # ttl_security: + # hops: 50 + # set: true + # - adjacency: true + # afi: ipv6 + # database_filter: true + # manet: + # link_metrics: + # cost_threshold: 10 + # priority: 55 + # process: + # area_id: '45' + # id: 35 + # transmit_delay: 45 + # name: GigabitEthernet0/1 + # - name: GigabitEthernet0/2 + # + # commands: + # - interface GigabitEthernet0/2 + # - ip ospf 10 area 20 + # - ip ospf adjacency stagger disable + # - ip ospf cost 30 + # - ip ospf priority 40 + # - ip ospf ttl-security hops 50 + # - interface GigabitEthernet0/1 + # - ipv6 ospf 55 area 105 + # - no ipv6 ospf database-filter all out + # - no ipv6 ospf manet peering link-metrics 10 + # - ipv6 ospf priority 20 + # - ipv6 ospf transmit-delay 30 + # - no ip ospf 10 area 30 + # - no ip ospf adjacency stagger disable + # - no ip ospf bfd + # - no ip ospf cost 5 + # - no ip ospf dead-interval 5 + # - no ip ospf demand-circuit ignore + # - no ip ospf network broadcast + # - no ip ospf priority 25 + # - no ip ospf resync-timeout 10 + # - no ip ospf shutdown + # - no ip ospf ttl-security hops 50 + # + # parsed: + # - name: GigabitEthernet0/0 + # - address_family: + # - adjacency: true + # afi: ipv6 + # priority: 20 + # process: + # area_id: '105' + # id: 55 + # transmit_delay: 30 + # name: GigabitEthernet0/1 + # - address_family: + # - adjacency: true + # afi: ipv4 + # cost: + # interface_cost: 30 + # priority: 40 + # process: + # area_id: '20' + # id: 10 + # ttl_security: + # hops: 50 + # set: true + # name: GigabitEthernet0/2 # - # "commands": [ - # "interface GigabitEthernet0/2", - # "ip ospf 10 area 20", - # "ip ospf adjacency stagger disable", - # "ip ospf cost 30", - # "ip ospf priority 40", - # "ip ospf ttl-security hops 50", - # "interface GigabitEthernet0/1", - # "ipv6 ospf 55 area 105", - # "no ipv6 ospf database-filter all out", - # "no ipv6 ospf manet peering link-metrics 10", - # "ipv6 ospf priority 20", - # "ipv6 ospf transmit-delay 30", - # "no ip ospf 10 area 30", - # "no ip ospf adjacency stagger disable", - # "no ip ospf bfd", - # "no ip ospf cost 5", - # "no ip ospf dead-interval 5", - # "no ip ospf demand-circuit ignore", - # "no ip ospf network broadcast", - # "no ip ospf priority 25", - # "no ip ospf resync-timeout 10", - # "no ip ospf shutdown", - # "no ip ospf ttl-security hops 50" - # ] - # After state: # ------------- # @@ -1833,18 +2003,102 @@ Examples transmit_delay: 30 state: replaced - # Commands Fired: - # --------------- - # "commands": [ - # "interface GigabitEthernet0/2", - # "ipv6 ospf 55 area 105", - # "ipv6 ospf adjacency stagger disable", - # "ipv6 ospf priority 20", - # "ipv6 ospf transmit-delay 30" - # ] + # Task Output: + # ------------ + # + # before: + # - name: GigabitEthernet0/0 + # - address_family: + # - adjacency: true + # afi: ipv4 + # bfd: true + # cost: + # interface_cost: 5 + # dead_interval: + # time: 5 + # demand_circuit: + # enable: true + # ignore: true + # network: + # broadcast: true + # priority: 25 + # process: + # area_id: '30' + # id: 10 + # resync_timeout: 10 + # shutdown: true + # ttl_security: + # hops: 50 + # set: true + # - adjacency: true + # afi: ipv6 + # database_filter: true + # manet: + # link_metrics: + # cost_threshold: 10 + # priority: 55 + # process: + # area_id: '45' + # id: 35 + # transmit_delay: 45 + # name: GigabitEthernet0/1 + # - name: GigabitEthernet0/2 + # + # commands: + # - interface GigabitEthernet0/2 + # - ipv6 ospf 55 area 105 + # - ipv6 ospf adjacency stagger disable + # - ipv6 ospf priority 20 + # - ipv6 ospf transmit-delay 30 + # + # after: + # - name: GigabitEthernet0/0 + # - address_family: + # - adjacency: true + # afi: ipv4 + # bfd: true + # cost: + # interface_cost: 5 + # dead_interval: + # time: 5 + # demand_circuit: + # enable: true + # ignore: true + # network: + # broadcast: true + # priority: 25 + # process: + # area_id: '30' + # id: 10 + # resync_timeout: 10 + # shutdown: true + # ttl_security: + # hops: 50 + # set: true + # - adjacency: true + # afi: ipv6 + # database_filter: true + # manet: + # link_metrics: + # cost_threshold: 10 + # priority: 55 + # process: + # area_id: '45' + # id: 35 + # transmit_delay: 45 + # name: GigabitEthernet0/1 + # - address_family: + # - adjacency: true + # afi: ipv6 + # priority: 20 + # process: + # area_id: '105' + # id: 55 + # transmit_delay: 30 + # name: GigabitEthernet0/2 # After state: - # ------------- + # ------------ # router-ios#sh running-config | section ^interface # interface GigabitEthernet0/0 # interface GigabitEthernet0/1 @@ -1903,65 +2157,46 @@ Examples config: state: gathered - # Module Execution Result: - # ------------------------ + # Task Output: + # ------------ # - # "gathered": [ - # { - # "name": "GigabitEthernet0/2" - # }, - # { - # "address_family": [ - # { - # "adjacency": true, - # "afi": "ipv4", - # "bfd": true, - # "cost": { - # "interface_cost": 5 - # }, - # "dead_interval": { - # "time": 5 - # }, - # "demand_circuit": { - # "ignore": true - # }, - # "network": { - # "broadcast": true - # }, - # "priority": 25, - # "process": { - # "area_id": "30", - # "id": 10 - # }, - # "resync_timeout": 10, - # "shutdown": true, - # "ttl_security": { - # "hops": 50 - # } - # }, - # { - # "adjacency": true, - # "afi": "ipv6", - # "database_filter": true, - # "manet": { - # "link_metrics": { - # "cost_threshold": 10 - # } - # }, - # "priority": 55, - # "process": { - # "area_id": "45", - # "id": 35 - # }, - # "transmit_delay": 45 - # } - # ], - # "name": "GigabitEthernet0/1" - # }, - # { - # "name": "GigabitEthernet0/0" - # } - # ] + # gathered: + # - name: GigabitEthernet0/0 + # - address_family: + # - adjacency: true + # afi: ipv4 + # bfd: true + # cost: + # interface_cost: 5 + # dead_interval: + # time: 5 + # demand_circuit: + # enable: true + # ignore: true + # network: + # broadcast: true + # priority: 25 + # process: + # area_id: '30' + # id: 10 + # resync_timeout: 10 + # shutdown: true + # ttl_security: + # hops: 50 + # set: true + # - adjacency: true + # afi: ipv6 + # database_filter: true + # manet: + # link_metrics: + # cost_threshold: 10 + # priority: 55 + # process: + # area_id: '45' + # id: 35 + # transmit_delay: 45 + # name: GigabitEthernet0/1 + # - name: GigabitEthernet0/2 # After state: # ------------ @@ -2027,29 +2262,29 @@ Examples transmit_delay: 45 state: rendered - # Module Execution Result: - # ------------------------ + # Task Output: + # ------------ + # + # rendered: + # - interface GigabitEthernet0/1 + # - ip ospf 10 area 30 + # - ip ospf adjacency stagger disable + # - ip ospf bfd + # - ip ospf cost 5 + # - ip ospf dead-interval 5 + # - ip ospf demand-circuit ignore + # - ip ospf network broadcast + # - ip ospf priority 25 + # - ip ospf resync-timeout 10 + # - ip ospf shutdown + # - ip ospf ttl-security hops 50 + # - ipv6 ospf 35 area 45 + # - ipv6 ospf adjacency stagger disable + # - ipv6 ospf database-filter all out + # - ipv6 ospf manet peering link-metrics 10 + # - ipv6 ospf priority 55 + # - ipv6 ospf transmit-delay 45 # - # "rendered": [ - # "interface GigabitEthernet0/1", - # "ip ospf 10 area 30", - # "ip ospf adjacency stagger disable", - # "ip ospf bfd", - # "ip ospf cost 5", - # "ip ospf dead-interval 5", - # "ip ospf demand-circuit ignore", - # "ip ospf network broadcast", - # "ip ospf priority 25", - # "ip ospf resync-timeout 10", - # "ip ospf shutdown", - # "ip ospf ttl-security hops 50", - # "ipv6 ospf 35 area 45", - # "ipv6 ospf adjacency stagger disable", - # "ipv6 ospf database-filter all out", - # "ipv6 ospf manet peering link-metrics 10", - # "ipv6 ospf priority 55", - # "ipv6 ospf transmit-delay 45" - # ] # Using Parsed @@ -2082,66 +2317,46 @@ Examples running_config: "{{ lookup('file', 'parsed.cfg') }}" state: parsed - # Module Execution Result: - # ------------------------ + # Task Output: + # ------------ # - # "parsed": [ - # }, - # { - # "name": "GigabitEthernet0/2" - # }, - # { - # "address_family": [ - # { - # "adjacency": true, - # "afi": "ipv4", - # "bfd": true, - # "cost": { - # "interface_cost": 5 - # }, - # "dead_interval": { - # "time": 5 - # }, - # "demand_circuit": { - # "ignore": true - # }, - # "network": { - # "broadcast": true - # }, - # "priority": 25, - # "process": { - # "area_id": "30", - # "id": 10 - # }, - # "resync_timeout": 10, - # "shutdown": true, - # "ttl_security": { - # "hops": 50 - # } - # }, - # { - # "adjacency": true, - # "afi": "ipv6", - # "database_filter": true, - # "manet": { - # "link_metrics": { - # "cost_threshold": 10 - # } - # }, - # "priority": 55, - # "process": { - # "area_id": "45", - # "id": 35 - # }, - # "transmit_delay": 45 - # } - # ], - # "name": "GigabitEthernet0/1" - # }, - # { - # "name": "GigabitEthernet0/0" - # } - # ] + # parsed: + # - name: GigabitEthernet0/2 + # - address_family: + # - adjacency: true + # afi: ipv4 + # bfd: true + # cost: + # interface_cost: 5 + # dead_interval: + # time: 5 + # demand_circuit: + # enable: true + # ignore: true + # network: + # broadcast: true + # priority: 25 + # process: + # area_id: '30' + # id: 10 + # resync_timeout: 10 + # shutdown: true + # ttl_security: + # hops: 50 + # set: true + # - adjacency: true + # afi: ipv6 + # database_filter: true + # manet: + # link_metrics: + # cost_threshold: 10 + # priority: 55 + # process: + # area_id: '45' + # id: 35 + # transmit_delay: 45 + # name: GigabitEthernet0/1 + # - name: GigabitEthernet0/0 @@ -2163,7 +2378,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late <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> + <span style="color: purple">list</span> </div> </td> <td>when changed</td> @@ -2180,7 +2395,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late <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> + <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> diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_ospfv2_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_ospfv2_module.rst index aeffea4cf..2cd986ce1 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_ospfv2_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_ospfv2_module.rst @@ -3661,9 +3661,9 @@ Parameters <td> </td> <td> - <div>passive_interface param is deprecated and a newer param passive_interfaces with added functionality's is introduced, please meke use of the new available passive_interfaces instead.</div> <div>Suppress routing updates on an interface (GigabitEthernet A/B)</div> <div>Interface name with respective interface number</div> + <div>passive_interface param is DEPRECATED and a newer param passive_interfaces with added functionality's is introduced, this attribute will be removed after 2026-07-18.</div> </td> </tr> <tr> @@ -4589,96 +4589,6 @@ Examples .. code-block:: yaml - # Using deleted - - # Before state: - # ------------- - # - # router-ios#sh running-config | section ^router ospf - # router ospf 200 vrf blue - # domain-id 192.0.3.1 - # max-metric router-lsa on-startup 100 - # auto-cost reference-bandwidth 4 - # area 10 capability default-exclusion - # distribute-list 10 out - # distribute-list 123 in - # router ospf 1 - # max-metric router-lsa on-startup 110 - # area 10 authentication message-digest - # area 10 nssa default-information-originate metric 10 - # area 10 nssa translate type7 suppress-fa - # area 10 default-cost 10 - # area 10 filter-list prefix test_prefix_out out - # network 198.51.100.0 0.0.0.255 area 5 - # default-information originate - - - name: Delete provided OSPF V2 processes - cisco.ios.ios_ospfv2: - config: - processes: - - process_id: 1 - - process_id: 200 - vrf: blue - state: deleted - - # Commands Fired: - # --------------- - # - # "commands": [ - # "no router ospf 1" - # ] - - # After state: - # ------------- - # router-ios#sh running-config | section ^router ospf - # router ospf 200 vrf blue - # domain-id 192.0.3.1 - # max-metric router-lsa on-startup 100 - # auto-cost reference-bandwidth 4 - # area 10 capability default-exclusion - # distribute-list 10 out - # distribute-list 123 in - - # Using deleted without any config passed (NOTE: This will delete all OSPFV2 configuration from device) - - # Before state: - # ------------- - # - # router-ios#sh running-config | section ^router ospf - # router ospf 200 vrf blue - # domain-id 192.0.3.1 - # max-metric router-lsa on-startup 100 - # auto-cost reference-bandwidth 4 - # area 10 capability default-exclusion - # distribute-list 10 out - # distribute-list 123 in - # router ospf 1 - # max-metric router-lsa on-startup 110 - # area 10 authentication message-digest - # area 10 nssa default-information-originate metric 10 - # area 10 nssa translate type7 suppress-fa - # area 10 default-cost 10 - # area 10 filter-list prefix test_prefix_out out - # network 198.51.100.0 0.0.0.255 area 5 - # default-information originate - - - name: Delete all OSPF processes - cisco.ios.ios_ospfv2: - state: deleted - - # Commands Fired: - # --------------- - # - # "commands": [ - # "no router ospf 200 vrf blue", - # "no router ospf 1" - # ] - - # After state: - # ------------- - # router-ios#sh running-config | section ^router ospf - # router-ios# - # Using merged # Before state: @@ -4723,7 +4633,7 @@ Examples passive_interfaces: default: true interface: - set_interface: False + set_interface: false name: - GigabitEthernet0/1 - GigabitEthernet0/2 @@ -4749,35 +4659,93 @@ Examples direction: in state: merged - # Commands Fired: - # --------------- - # - # "commands": [ - # "router ospf 200 vrf blue", - # "auto-cost reference-bandwidth 4", - # "distribute-list 10 out", - # "distribute-list 123 in", - # "domain-id 192.0.3.1", - # "max-metric router-lsa on-startup 100", - # "area 10 capability default-exclusion", - # "router ospf 1", - # "default-information originate", - # "max-metric router-lsa on-startup 110", - # "network 198.51.100.0 0.0.0.255 area 5", - # "area 10 authentication message-digest", - # "area 10 default-cost 10", - # "area 10 nssa translate type7 suppress-fa", - # "area 10 nssa default-information-originate metric 10", - # "area 10 filter-list prefix test_prefix_out out", - # "area 10 filter-list prefix test_prefix_in in", - # "area 5 authentication", - # "area 5 capability default-exclusion" - # "passive-interface default" - # "no passive-interface GigabitEthernet0/1" - # ] + # Task Output: + # ------------ + + # before: {} + # commands: + # - router ospf 200 vrf blue + # - auto-cost reference-bandwidth 4 + # - domain-id 192.0.3.1 + # - max-metric router-lsa on-startup 100 + # - area 10 capability default-exclusion + # - distribute-list 10 out + # - distribute-list 123 in + # - router ospf 1 + # - default-information originate + # - max-metric router-lsa on-startup 110 + # - area 5 capability default-exclusion + # - area 10 authentication message-digest + # - area 10 default-cost 10 + # - area 10 nssa default-information-originate metric 10 + # - area 10 nssa translate type7 suppress-fa + # - area 10 filter-list prefix test_prefix_in in + # - area 10 filter-list prefix test_prefix_out out + # - network 198.51.100.0 0.0.0.255 area 5 + # - passive-interface default + # - no passive-interface GigabitEthernet0/1 + # - no passive-interface GigabitEthernet0/2 + + # after: + # processes: + # - areas: + # - area_id: '10' + # capability: true + # auto_cost: + # reference_bandwidth: 4 + # set: true + # distribute_list: + # acls: + # - direction: out + # name: '10' + # - direction: in + # name: '123' + # domain_id: + # ip_address: + # address: 192.0.3.1 + # max_metric: + # on_startup: + # time: 100 + # router_lsa: true + # process_id: 200 + # vrf: blue + # - areas: + # - area_id: '5' + # capability: true + # - area_id: '10' + # authentication: + # message_digest: true + # default_cost: 10 + # filter_list: + # - direction: in + # name: test_prefix_in + # - direction: out + # name: test_prefix_out + # nssa: + # default_information_originate: + # metric: 10 + # translate: suppress-fa + # default_information: + # originate: true + # max_metric: + # on_startup: + # time: 110 + # router_lsa: true + # network: + # - address: 198.51.100.0 + # area: '5' + # wildcard_bits: 0.0.0.255 + # passive_interfaces: + # default: true + # interface: + # name: + # - GigabitEthernet2 + # - GigabitEthernet1 + # set_interface: false + # process_id: 1 # After state: - # ------------- + # ------------ # # router-ios#sh running-config | section ^router ospf # router ospf 200 vrf blue @@ -4789,18 +4757,20 @@ Examples # distribute-list 123 in # router ospf 1 # max-metric router-lsa on-startup 110 + # area 5 capability default-exclusion # area 10 authentication message-digest # area 10 nssa default-information-originate metric 10 # area 10 nssa translate type7 suppress-fa # area 10 default-cost 10 + # area 10 filter-list prefix test_prefix_in in # area 10 filter-list prefix test_prefix_out out + # passive-interface default + # no passive-interface GigabitEthernet1 + # no passive-interface GigabitEthernet2 # network 198.51.100.0 0.0.0.255 area 5 # default-information originate - # passive-interface default - # no passive-interface GigabitEthernet0/1 - # no passive-interface GigabitEthernet0/2 - # Using overridden + # Using replaced # Before state: # ------------- @@ -4815,15 +4785,20 @@ Examples # distribute-list 123 in # router ospf 1 # max-metric router-lsa on-startup 110 + # area 5 capability default-exclusion # area 10 authentication message-digest # area 10 nssa default-information-originate metric 10 # area 10 nssa translate type7 suppress-fa # area 10 default-cost 10 + # area 10 filter-list prefix test_prefix_in in # area 10 filter-list prefix test_prefix_out out + # passive-interface default + # no passive-interface GigabitEthernet1 + # no passive-interface GigabitEthernet2 # network 198.51.100.0 0.0.0.255 area 5 # default-information originate - - name: Override provided OSPF V2 configuration + - name: Replace running config with provided OSPF V2 configuration cisco.ios.ios_ospfv2: config: processes: @@ -4859,35 +4834,156 @@ Examples default_information_originate: metric: 10 translate: suppress-fa - state: overridden + state: replaced - # Commands Fired: - # --------------- + # Task Output: + # ------------ + # + # before: + # processes: + # - areas: + # - area_id: '10' + # capability: true + # auto_cost: + # reference_bandwidth: 4 + # set: true + # distribute_list: + # acls: + # - direction: out + # name: '10' + # - direction: in + # name: '123' + # domain_id: + # ip_address: + # address: 192.0.3.1 + # max_metric: + # on_startup: + # time: 100 + # router_lsa: true + # process_id: 200 + # vrf: blue + # - areas: + # - area_id: '5' + # capability: true + # - area_id: '10' + # authentication: + # message_digest: true + # default_cost: 10 + # filter_list: + # - direction: in + # name: test_prefix_in + # - direction: out + # name: test_prefix_out + # nssa: + # default_information_originate: + # metric: 10 + # translate: suppress-fa + # default_information: + # originate: true + # max_metric: + # on_startup: + # time: 110 + # router_lsa: true + # network: + # - address: 198.51.100.0 + # area: '5' + # wildcard_bits: 0.0.0.255 + # passive_interfaces: + # default: true + # interface: + # name: + # - GigabitEthernet2 + # - GigabitEthernet1 + # set_interface: false + # process_id: 1 # - # "commands": [ - # "no router ospf 1", - # "router ospf 100 vrf ospf_vrf", - # "auto-cost reference-bandwidth 5", - # "domain-id 192.0.5.1", - # "area 5 authentication message-digest", - # "area 5 nssa translate type7 suppress-fa", - # "area 5 nssa default-information-originate metric 10", - # "router ospf 200 vrf blue", - # "no auto-cost reference-bandwidth 4", - # "no distribute-list 10 out", - # "no distribute-list 123 in", - # "domain-id 192.0.4.1", - # "max-metric router-lsa on-startup 200", - # "maximum-paths 15", - # "ttl-security all-interfaces hops 7", - # "area 10 authentication message-digest", - # "no area 10 capability default-exclusion", - # "area 10 default-cost 10" + # commands: + # - router ospf 100 vrf ospf_vrf + # - auto-cost reference-bandwidth 5 + # - domain-id 192.0.5.1 + # - area 5 authentication message-digest + # - area 5 nssa translate type7 suppress-fa + # - area 5 nssa default-information-originate metric 10 + # - router ospf 200 vrf blue + # - no auto-cost reference-bandwidth 4 + # - no distribute-list 10 out + # - no distribute-list 123 in + # - domain-id 192.0.4.1 + # - max-metric router-lsa on-startup 200 + # - maximum-paths 15 + # - ttl-security all-interfaces hops 7 + # - area 10 authentication message-digest + # - no area 10 capability default-exclusion + # - area 10 default-cost 10 # ] + # + # after: + # processes: + # - areas: + # - area_id: '10' + # authentication: + # message_digest: true + # default_cost: 10 + # domain_id: + # ip_address: + # address: 192.0.4.1 + # max_metric: + # on_startup: + # time: 200 + # router_lsa: true + # maximum_paths: 15 + # process_id: 200 + # ttl_security: + # hops: 7 + # vrf: blue + # - areas: + # - area_id: '5' + # authentication: + # message_digest: true + # nssa: + # default_information_originate: + # metric: 10 + # translate: suppress-fa + # auto_cost: + # reference_bandwidth: 5 + # set: true + # domain_id: + # ip_address: + # address: 192.0.5.1 + # process_id: 100 + # vrf: ospf_vrf + # - areas: + # - area_id: '5' + # authentication: + # enable: true + # capability: true + # - area_id: '10' + # authentication: + # message_digest: true + # default_cost: 10 + # filter_list: + # - direction: in + # name: test_prefix_in + # - direction: out + # name: test_prefix_out + # nssa: + # default_information_originate: + # metric: 10 + # translate: suppress-fa + # default_information: + # originate: true + # max_metric: + # on_startup: + # time: 110 + # router_lsa: true + # network: + # - address: 198.51.100.0 + # area: '5' + # wildcard_bits: 0.0.0.255 + # process_id: 1 # After state: # ------------- - # # router-ios#sh running-config | section ^router ospf # router ospf 200 vrf blue # domain-id 192.0.4.1 @@ -4902,8 +4998,20 @@ Examples # area 5 authentication message-digest # area 5 nssa default-information-originate metric 10 # area 5 nssa translate type7 suppress-fa + # router ospf 1 + # max-metric router-lsa on-startup 110 + # area 5 capability default-exclusion + # area 5 authentication + # area 10 authentication message-digest + # area 10 nssa default-information-originate metric 10 + # area 10 nssa translate type7 suppress-fa + # area 10 default-cost 10 + # area 10 filter-list prefix test_prefix_in in + # area 10 filter-list prefix test_prefix_out out + # network 198.51.100.0 0.0.0.255 area 5 + # default-information originate - # Using replaced + # Using overridden # Before state: # ------------- @@ -4926,7 +5034,7 @@ Examples # network 198.51.100.0 0.0.0.255 area 5 # default-information originate - - name: Replaced provided OSPF V2 configuration + - name: Override provided OSPF V2 configuration cisco.ios.ios_ospfv2: config: processes: @@ -4962,32 +5070,117 @@ Examples default_information_originate: metric: 10 translate: suppress-fa - state: replaced + state: overridden - # Commands Fired: - # --------------- - # "commands": [ - # "router ospf 100 vrf ospf_vrf", - # "auto-cost reference-bandwidth 5", - # "domain-id 192.0.5.1", - # "area 5 authentication message-digest", - # "area 5 nssa translate type7 suppress-fa", - # "area 5 nssa default-information-originate metric 10", - # "router ospf 200 vrf blue", - # "no auto-cost reference-bandwidth 4", - # "no distribute-list 10 out", - # "no distribute-list 123 in", - # "domain-id 192.0.4.1", - # "max-metric router-lsa on-startup 200", - # "maximum-paths 15", - # "ttl-security all-interfaces hops 7", - # "area 10 authentication message-digest", - # "no area 10 capability default-exclusion", - # "area 10 default-cost 10" - # ] + # Task Output: + # ------------ + # before: + # processes: + # - areas: + # - area_id: '10' + # capability: true + # auto_cost: + # reference_bandwidth: 4 + # set: true + # distribute_list: + # acls: + # - direction: out + # name: '10' + # - direction: in + # name: '123' + # domain_id: + # ip_address: + # address: 192.0.3.1 + # max_metric: + # on_startup: + # time: 100 + # router_lsa: true + # process_id: 200 + # vrf: blue + # - areas: + # - area_id: '10' + # authentication: + # message_digest: true + # default_cost: 10 + # filter_list: + # - direction: out + # name: test_prefix_out + # nssa: + # default_information_originate: + # metric: 10 + # translate: suppress-fa + # default_information: + # originate: true + # max_metric: + # on_startup: + # time: 110 + # router_lsa: true + # network: + # - address: 198.51.100.0 + # area: '5' + # wildcard_bits: 0.0.0.255 + # process_id: 1 + # + # commands: + # - no router ospf 1 + # - router ospf 100 vrf ospf_vrf + # - auto-cost reference-bandwidth 5 + # - domain-id 192.0.5.1 + # - area 5 authentication message-digest + # - area 5 nssa translate type7 suppress-fa + # - area 5 nssa default-information-originate metric 10 + # - router ospf 200 vrf blue + # - no auto-cost reference-bandwidth 4 + # - no distribute-list 10 out + # - no distribute-list 123 in + # - domain-id 192.0.4.1 + # - max-metric router-lsa on-startup 200 + # - maximum-paths 15 + # - ttl-security all-interfaces hops 7 + # - area 10 authentication message-digest + # - no area 10 capability default-exclusion + # - area 10 default-cost 10 + # + # after: + # processes: + # - areas: + # - area_id: '10' + # authentication: + # message_digest: true + # default_cost: 10 + # domain_id: + # ip_address: + # address: 192.0.4.1 + # max_metric: + # on_startup: + # time: 200 + # router_lsa: true + # maximum_paths: 15 + # process_id: 200 + # ttl_security: + # hops: 7 + # vrf: blue + # - areas: + # - area_id: '5' + # authentication: + # message_digest: true + # nssa: + # default_information_originate: + # metric: 10 + # translate: suppress-fa + # auto_cost: + # reference_bandwidth: 5 + # set: true + # domain_id: + # ip_address: + # address: 192.0.5.1 + # process_id: 100 + # vrf: ospf_vrf + # # After state: - # ------------- + # ------------ + # # router-ios#sh running-config | section ^router ospf # router ospf 200 vrf blue # domain-id 192.0.4.1 @@ -5002,19 +5195,214 @@ Examples # area 5 authentication message-digest # area 5 nssa default-information-originate metric 10 # area 5 nssa translate type7 suppress-fa + + # Using deleted + + # Before state: + # ------------- + # + # router-ios#sh running-config | section ^router ospf + # router ospf 200 vrf blue + # domain-id 192.0.3.1 + # max-metric router-lsa on-startup 100 + # auto-cost reference-bandwidth 4 + # area 10 capability default-exclusion + # distribute-list 10 out + # distribute-list 123 in + # router ospf 1 + # max-metric router-lsa on-startup 110 + # area 10 authentication message-digest + # area 10 nssa default-information-originate metric 10 + # area 10 nssa translate type7 suppress-fa + # area 10 default-cost 10 + # area 10 filter-list prefix test_prefix_out out + # network 198.51.100.0 0.0.0.255 area 5 + # default-information originate + + - name: Delete provided OSPF V2 processes + cisco.ios.ios_ospfv2: + config: + processes: + - process_id: 1 + - process_id: 200 + vrf: blue + state: deleted + + # Task Output: + # ------------ + + # before: + # processes: + # - areas: + # - area_id: '10' + # capability: true + # auto_cost: + # reference_bandwidth: 4 + # set: true + # distribute_list: + # acls: + # - direction: out + # name: '10' + # - direction: in + # name: '123' + # domain_id: + # ip_address: + # address: 192.0.3.1 + # max_metric: + # on_startup: + # time: 100 + # router_lsa: true + # process_id: 200 + # vrf: blue + # - areas: + # - area_id: '10' + # authentication: + # message_digest: true + # default_cost: 10 + # filter_list: + # - direction: out + # name: test_prefix_out + # nssa: + # default_information_originate: + # metric: 10 + # translate: suppress-fa + # default_information: + # originate: true + # max_metric: + # on_startup: + # time: 110 + # router_lsa: true + # network: + # - address: 198.51.100.0 + # area: '5' + # wildcard_bits: 0.0.0.255 + # process_id: 1 + # + # commands: + # - no router ospf 1 + # + # processes: + # - areas: + # - area_id: '10' + # capability: true + # auto_cost: + # reference_bandwidth: 4 + # set: true + # distribute_list: + # acls: + # - direction: out + # name: '10' + # - direction: in + # name: '123' + # domain_id: + # ip_address: + # address: 192.0.3.1 + # max_metric: + # on_startup: + # time: 100 + # router_lsa: true + # process_id: 200 + # vrf: blue + # + # After state: + # ------------ + # router-ios#sh running-config | section ^router ospf + # router ospf 200 vrf blue + # domain-id 192.0.3.1 + # max-metric router-lsa on-startup 100 + # auto-cost reference-bandwidth 4 + # area 10 capability default-exclusion + # distribute-list 10 out + # distribute-list 123 in + + # Using deleted without any config passed (NOTE: This will delete all OSPFV2 configuration from device) + + # Before state: + # ------------- + # + # router-ios#sh running-config | section ^router ospf + # router ospf 200 vrf blue + # domain-id 192.0.3.1 + # max-metric router-lsa on-startup 100 + # auto-cost reference-bandwidth 4 + # area 10 capability default-exclusion + # distribute-list 10 out + # distribute-list 123 in # router ospf 1 # max-metric router-lsa on-startup 110 - # area 5 capability default-exclusion - # area 5 authentication # area 10 authentication message-digest # area 10 nssa default-information-originate metric 10 # area 10 nssa translate type7 suppress-fa # area 10 default-cost 10 - # area 10 filter-list prefix test_prefix_in in # area 10 filter-list prefix test_prefix_out out # network 198.51.100.0 0.0.0.255 area 5 # default-information originate + - name: Delete all OSPF processes + cisco.ios.ios_ospfv2: + state: deleted + + # Task Output: + # ------------ + + # before: + # processes: + # - areas: + # - area_id: '10' + # capability: true + # auto_cost: + # reference_bandwidth: 4 + # set: true + # distribute_list: + # acls: + # - direction: out + # name: '10' + # - direction: in + # name: '123' + # domain_id: + # ip_address: + # address: 192.0.3.1 + # max_metric: + # on_startup: + # time: 100 + # router_lsa: true + # process_id: 200 + # vrf: blue + # - areas: + # - area_id: '10' + # authentication: + # message_digest: true + # default_cost: 10 + # filter_list: + # - direction: out + # name: test_prefix_out + # nssa: + # default_information_originate: + # metric: 10 + # translate: suppress-fa + # default_information: + # originate: true + # max_metric: + # on_startup: + # time: 110 + # router_lsa: true + # network: + # - address: 198.51.100.0 + # area: '5' + # wildcard_bits: 0.0.0.255 + # process_id: 1 + # + # commands: + # - no router ospf 200 vrf blue + # - no router ospf 1 + # + # after: {} + # + # After state: + # ------------ + # router-ios#sh running-config | section ^router ospf + # router-ios# + # Using Gathered # Before state: @@ -5038,103 +5426,61 @@ Examples # network 198.51.100.0 0.0.0.255 area 5 # default-information originate - - name: Gather OSPFV2 provided configurations + - name: Gather OSPFV2 running configurations cisco.ios.ios_ospfv2: config: state: gathered - # Module Execution Result: - # ------------------------ + # Task Output: + # ------------ # - # "gathered": { - # "processes": [ - # { - # "areas": [ - # { - # "area_id": "5", - # "authentication": { - # "enable": true - # }, - # "capability": true - # }, - # { - # "area_id": "10", - # "authentication": { - # "message_digest": true - # }, - # "default_cost": 10, - # "filter_list": [ - # { - # "direction": "in", - # "name": "test_prefix_in" - # }, - # { - # "direction": "out", - # "name": "test_prefix_out" - # } - # ], - # "nssa": { - # "default_information_originate": { - # "metric": 10 - # }, - # "translate": "suppress-fa" - # } - # } - # ], - # "default_information": { - # "originate": true - # }, - # "max_metric": { - # "on_startup": { - # "time": 110 - # }, - # "router_lsa": true - # }, - # "network": { - # "address": "198.51.100.0", - # "area": "5", - # "wildcard_bits": "0.0.0.255" - # }, - # "process_id": 1 - # }, - # { - # "areas": [ - # { - # "area_id": "10", - # "capability": true - # } - # ], - # "auto_cost": { - # "reference_bandwidth": 4 - # }, - # "distribute_list": { - # "acls": [ - # { - # "direction": "out", - # "name": "10" - # }, - # { - # "direction": "in", - # "name": "123" - # } - # ] - # }, - # "domain_id": { - # "ip_address": { - # "address": "192.0.3.1" - # } - # }, - # "max_metric": { - # "on_startup": { - # "time": 100 - # }, - # "router_lsa": true - # }, - # "process_id": 200, - # "vrf": "blue" - # } - # ] - # } + # gathered: + # processes: + # - areas: + # - area_id: '10' + # capability: true + # auto_cost: + # reference_bandwidth: 4 + # set: true + # distribute_list: + # acls: + # - direction: out + # name: '10' + # - direction: in + # name: '123' + # domain_id: + # ip_address: + # address: 192.0.3.1 + # max_metric: + # on_startup: + # time: 100 + # router_lsa: true + # process_id: 200 + # vrf: blue + # - areas: + # - area_id: '10' + # authentication: + # message_digest: true + # default_cost: 10 + # filter_list: + # - direction: out + # name: test_prefix_out + # nssa: + # default_information_originate: + # metric: 10 + # translate: suppress-fa + # default_information: + # originate: true + # max_metric: + # on_startup: + # time: 110 + # router_lsa: true + # network: + # - address: 198.51.100.0 + # area: '5' + # wildcard_bits: 0.0.0.255 + # process_id: 1 + # After state: # ------------ @@ -5214,30 +5560,30 @@ Examples direction: in state: rendered - # Module Execution Result: - # ------------------------ + # Task Output: + # ------------ + + # rendered: + # - router ospf 200 vrf blue + # - auto-cost reference-bandwidth 4 + # - distribute-list 10 out + # - distribute-list 123 in + # - domain-id 192.0.3.1 + # - max-metric router-lsa on-startup 100 + # - area 10 capability default-exclusion + # - router ospf 1 + # - default-information originate + # - max-metric router-lsa on-startup 110 + # - network 198.51.100.0 0.0.0.255 area 5 + # - area 10 authentication message-digest + # - area 10 default-cost 10 + # - area 10 nssa translate type7 suppress-fa + # - area 10 nssa default-information-originate metric 10 + # - area 10 filter-list prefix test_prefix_out out + # - area 10 filter-list prefix test_prefix_in in + # - area 5 authentication + # - area 5 capability default-exclusion # - # "rendered": [ - # "router ospf 200 vrf blue", - # "auto-cost reference-bandwidth 4", - # "distribute-list 10 out", - # "distribute-list 123 in", - # "domain-id 192.0.3.1", - # "max-metric router-lsa on-startup 100", - # "area 10 capability default-exclusion", - # "router ospf 1", - # "default-information originate", - # "max-metric router-lsa on-startup 110", - # "network 198.51.100.0 0.0.0.255 area 5", - # "area 10 authentication message-digest", - # "area 10 default-cost 10", - # "area 10 nssa translate type7 suppress-fa", - # "area 10 nssa default-information-originate metric 10", - # "area 10 filter-list prefix test_prefix_out out", - # "area 10 filter-list prefix test_prefix_in in", - # "area 5 authentication", - # "area 5 capability default-exclusion" - # ] # Using Parsed @@ -5256,38 +5602,26 @@ Examples running_config: "{{ lookup('file', 'parsed.cfg') }}" state: parsed - # Module Execution Result: - # ------------------------ - # - # "parsed": { - # "processes": [ - # { - # "areas": [ - # { - # "area_id": "5", - # "authentication": { - # "message_digest": true - # }, - # "nssa": { - # "default_information_originate": { - # "metric": 10 - # }, - # "translate": "suppress-fa" - # } - # } - # ], - # "auto_cost": { - # "reference_bandwidth": 5 - # }, - # "domain_id": { - # "ip_address": { - # "address": "192.0.5.1" - # } - # }, - # "process_id": 100 - # } - # ] - # } + # Task Output: + # ------------ + + # parsed: + # processes: + # - areas: + # - area_id: '5' + # authentication: + # message_digest: true + # nssa: + # default_information_originate: + # metric: 10 + # translate: suppress-fa + # auto_cost: + # reference_bandwidth: 5 + # set: true + # domain_id: + # ip_address: + # address: 192.0.5.1 + # process_id: 100 @@ -5356,6 +5690,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 200 vrf blue', 'auto-cost reference-bandwidth 5', 'domain-id 192.0.4.1']</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 200 vrf blue', 'auto-cost reference-bandwidth 4', 'distribute-list 10 out']</div> + </td> + </tr> </table> <br/><br/> @@ -5368,3 +5753,4 @@ Authors ~~~~~~~ - Sumit Jaiswal (@justjais) +- Vinay M (@roverflow) diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_ospfv3_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_ospfv3_module.rst index af86b6cfa..950c4ed9e 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_ospfv3_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_ospfv3_module.rst @@ -6572,92 +6572,6 @@ Examples .. code-block:: yaml - # Using deleted - - # Before state: - # ------------- - # - # router-ios#sh running-config | section ^router ospfv3 - # router ospfv3 1 - # max-metric router-lsa on-startup 110 - # area 10 nssa default-information-originate metric 10 - # ! - # address-family ipv4 unicast vrf blue - # adjacency stagger 50 50 - # area 25 nssa default-information-originate metric 25 nssa-only - # exit-address-family - # router ospfv3 200 - # max-metric router-lsa on-startup 100 - # auto-cost reference-bandwidth 4 - # ! - # address-family ipv4 unicast - # adjacency stagger 200 200 - # exit-address-family - - - name: Delete provided OSPF V3 processes - cisco.ios.ios_ospfv3: - config: - processes: - - process_id: 1 - state: deleted - - # Commands Fired: - # --------------- - # - # "commands": [ - # "no router ospfv3 1" - # ] - - # After state: - # ------------- - # router-ios#sh running-config | section ^router ospfv3 - # router ospfv3 200 - # max-metric router-lsa on-startup 100 - # auto-cost reference-bandwidth 4 - # ! - # address-family ipv4 unicast - # adjacency stagger 200 200 - # exit-address-family - - # Using deleted without any config passed (NOTE: This will delete all OSPFV3 configuration from device) - - # Before state: - # ------------- - # - # router-ios#sh running-config | section ^router ospfv3 - # router ospfv3 1 - # max-metric router-lsa on-startup 110 - # area 10 nssa default-information-originate metric 10 - # ! - # address-family ipv4 unicast vrf blue - # adjacency stagger 50 50 - # area 25 nssa default-information-originate metric 25 nssa-only - # exit-address-family - # router ospfv3 200 - # max-metric router-lsa on-startup 100 - # auto-cost reference-bandwidth 4 - # ! - # address-family ipv4 unicast - # adjacency stagger 200 200 - # exit-address-family - - - name: Delete all OSPF processes - cisco.ios.ios_ospfv3: - state: deleted - - # Commands Fired: - # --------------- - # - # "commands": [ - # "no router ospfv3 200", - # "no router ospfv3 1" - # ] - - # After state: - # ------------- - # router-ios#sh running-config | section ^router ospfv3 - # router-ios# - # Using merged # Before state: @@ -6714,26 +6628,189 @@ Examples reference_bandwidth: 4 state: merged - # Commands Fired: - # --------------- + # Task Output: + # ------------ + + # before: {} + # + # commands: + # - router ospfv3 1 + # - max-metric router-lsa on-startup 110 + # - area 10 nssa default-information-originate metric 10 + # - address-family ipv4 unicast vrf blue + # - adjacency stagger 50 50 + # - area 25 nssa default-information-originate metric 25 nssa-only + # - exit-address-family + # - router ospfv3 200 + # - auto-cost reference-bandwidth 4 + # - max-metric router-lsa on-startup 100 + # - address-family ipv4 unicast + # - adjacency stagger 200 200 + # - exit-address-family # - # "commands": [ - # "router ospfv3 1", - # "max-metric router-lsa on-startup 110", - # "area 10 nssa default-information-originate metric 10", - # "address-family ipv4 unicast vrf blue", - # "adjacency stagger 50 50", - # "area 25 nssa default-information-originate metric 25 nssa-only", - # "exit-address-family", - # "router ospfv3 200", - # "auto-cost reference-bandwidth 4", - # "max-metric router-lsa on-startup 100", - # "address-family ipv4 unicast", - # "adjacency stagger 200 200", - # "exit-address-family" - # ] + # after: + # processes: + # - address_family: + # - adjacency: + # max_adjacency: 50 + # min_adjacency: 50 + # afi: ipv4 + # areas: + # - area_id: '25' + # nssa: + # default_information_originate: + # metric: 25 + # nssa_only: true + # unicast: true + # vrf: blue + # areas: + # - area_id: '10' + # nssa: + # default_information_originate: + # metric: 10 + # max_metric: + # on_startup: + # time: 110 + # router_lsa: true + # process_id: 1 + # - address_family: + # - adjacency: + # max_adjacency: 200 + # min_adjacency: 200 + # afi: ipv4 + # unicast: true + # auto_cost: + # reference_bandwidth: 4 + # max_metric: + # on_startup: + # time: 100 + # router_lsa: true + # process_id: 200 + + # After state: + # ------------- + # + # router-ios#sh running-config | section ^router ospfv3 + # router ospfv3 1 + # max-metric router-lsa on-startup 110 + # area 10 nssa default-information-originate metric 10 + # ! + # address-family ipv4 unicast vrf blue + # adjacency stagger 50 50 + # area 25 nssa default-information-originate metric 25 nssa-only + # exit-address-family + # router ospfv3 200 + # max-metric router-lsa on-startup 100 + # auto-cost reference-bandwidth 4 + # ! + # address-family ipv4 unicast + # adjacency stagger 200 200 + # exit-address-family + + # Using deleted + + # Before state: + # ------------- + # + # router-ios#sh running-config | section ^router ospfv3 + # router ospfv3 1 + # max-metric router-lsa on-startup 110 + # area 10 nssa default-information-originate metric 10 + # ! + # address-family ipv4 unicast vrf blue + # adjacency stagger 50 50 + # area 25 nssa default-information-originate metric 25 nssa-only + # exit-address-family + # router ospfv3 200 + # max-metric router-lsa on-startup 100 + # auto-cost reference-bandwidth 4 + # ! + # address-family ipv4 unicast + # adjacency stagger 200 200 + # exit-address-family + - name: Delete provided OSPF V3 processes + cisco.ios.ios_ospfv3: + config: + processes: + - process_id: 1 + state: deleted + + # Task Output: + # ------------ + + # before: + # processes: + # - address_family: + # - adjacency: + # max_adjacency: 50 + # min_adjacency: 50 + # afi: ipv4 + # areas: + # - area_id: '25' + # nssa: + # default_information_originate: + # metric: 25 + # nssa_only: true + # unicast: true + # vrf: blue + # areas: + # - area_id: '10' + # nssa: + # default_information_originate: + # metric: 10 + # max_metric: + # on_startup: + # time: 110 + # router_lsa: true + # process_id: 1 + # - address_family: + # - adjacency: + # max_adjacency: 200 + # min_adjacency: 200 + # afi: ipv4 + # unicast: true + # auto_cost: + # reference_bandwidth: 4 + # max_metric: + # on_startup: + # time: 100 + # router_lsa: true + # process_id: 200 + # + # commands: + # - no router ospfv3 1 + # + # parsed: + # processes: + # - address_family: + # - adjacency: + # max_adjacency: 200 + # min_adjacency: 200 + # afi: ipv4 + # unicast: true + # auto_cost: + # reference_bandwidth: 4 + # max_metric: + # on_startup: + # time: 100 + # router_lsa: true + # process_id: 200 + # # After state: + # ------------ + # router-ios#sh running-config | section ^router ospfv3 + # router ospfv3 200 + # max-metric router-lsa on-startup 100 + # auto-cost reference-bandwidth 4 + # ! + # address-family ipv4 unicast + # adjacency stagger 200 200 + # exit-address-family + + # Using deleted without any config passed (NOTE: This will delete all OSPFV3 configuration from device) + + # Before state: # ------------- # # router-ios#sh running-config | section ^router ospfv3 @@ -6753,6 +6830,64 @@ Examples # adjacency stagger 200 200 # exit-address-family + - name: Delete all OSPF processes + cisco.ios.ios_ospfv3: + state: deleted + + # Task Output: + # ------------ + + # before: + # processes: + # - address_family: + # - adjacency: + # max_adjacency: 50 + # min_adjacency: 50 + # afi: ipv4 + # areas: + # - area_id: '25' + # nssa: + # default_information_originate: + # metric: 25 + # nssa_only: true + # unicast: true + # vrf: blue + # areas: + # - area_id: '10' + # nssa: + # default_information_originate: + # metric: 10 + # max_metric: + # on_startup: + # time: 110 + # router_lsa: true + # process_id: 1 + # - address_family: + # - adjacency: + # max_adjacency: 200 + # min_adjacency: 200 + # afi: ipv4 + # unicast: true + # auto_cost: + # reference_bandwidth: 4 + # max_metric: + # on_startup: + # time: 100 + # router_lsa: true + # process_id: 200 + # + # commands: + # - no router ospfv3 200 + # - no router ospfv3 1 + # + # after: {} + # + # After state: + # ------------ + # router-ios#sh running-config | section ^router ospfv3 + # router-ios# + + # Using overridden # Before state: @@ -6802,23 +6937,86 @@ Examples metric: 10 state: overridden - # Commands Fired: - # --------------- + # Task Output: + # ------------ + + # before: + # processes: + # - address_family: + # - adjacency: + # max_adjacency: 50 + # min_adjacency: 50 + # afi: ipv4 + # areas: + # - area_id: '25' + # nssa: + # default_information_originate: + # metric: 25 + # nssa_only: true + # unicast: true + # vrf: blue + # areas: + # - area_id: '10' + # nssa: + # default_information_originate: + # metric: 10 + # max_metric: + # on_startup: + # time: 110 + # router_lsa: true + # process_id: 1 + # - address_family: + # - adjacency: + # max_adjacency: 200 + # min_adjacency: 200 + # afi: ipv4 + # unicast: true + # auto_cost: + # reference_bandwidth: 4 + # max_metric: + # on_startup: + # time: 100 + # router_lsa: true + # process_id: 200 + # + # commands: + # - no router ospfv3 1 + # - router ospfv3 200 + # - no auto-cost reference-bandwidth 4 + # - max-metric router-lsa on-startup 200 + # - area 10 nssa default-information-originate metric 10 + # - address-family ipv4 unicast + # - adjacency stagger 50 50 + # - area 200 nssa default-information-originate metric 200 nssa-only + # - exit-address-family # - # "commands": [ - # "no router ospfv3 1", - # "router ospfv3 200", - # "no auto-cost reference-bandwidth 4", - # "max-metric router-lsa on-startup 200", - # "area 10 nssa default-information-originate metric 10", - # "address-family ipv4 unicast", - # "adjacency stagger 50 50", - # "area 200 nssa default-information-originate metric 200 nssa-only", - # "exit-address-family" - # ] + # after: + # processes: + # - address_family: + # - adjacency: + # max_adjacency: 50 + # min_adjacency: 50 + # afi: ipv4 + # areas: + # - area_id: '200' + # nssa: + # default_information_originate: + # metric: 200 + # nssa_only: true + # unicast: true + # areas: + # - area_id: '10' + # nssa: + # default_information_originate: + # metric: 10 + # max_metric: + # on_startup: + # time: 200 + # router_lsa: true + # process_id: 200 # After state: - # ------------- + # ------------ # # router-ios#sh running-config | section ^router ospfv3 # router ospfv3 200 @@ -6852,7 +7050,7 @@ Examples # adjacency stagger 200 200 # exit-address-family - - name: Replaced provided OSPFV3 configuration + - name: Perform replace with provided configurations. cisco.ios.ios_ospfv3: config: processes: @@ -6880,19 +7078,103 @@ Examples metric: 10 state: replaced - # Commands Fired: - # --------------- - # "commands": [ - # "router ospfv3 200", - # "no auto-cost reference-bandwidth 4", - # "max-metric router-lsa on-startup 200", - # "area 10 nssa default-information-originate metric 10", - # "address-family ipv4 unicast", - # "adjacency stagger 50 50", - # "area 200 nssa default-information-originate metric 200 nssa-only", - # "exit-address-family" - # ] + # Task Output: + # ------------ + # before: + # processes: + # - address_family: + # - adjacency: + # max_adjacency: 50 + # min_adjacency: 50 + # afi: ipv4 + # areas: + # - area_id: '25' + # nssa: + # default_information_originate: + # metric: 25 + # nssa_only: true + # unicast: true + # vrf: blue + # areas: + # - area_id: '10' + # nssa: + # default_information_originate: + # metric: 10 + # max_metric: + # on_startup: + # time: 110 + # router_lsa: true + # process_id: 1 + # - address_family: + # - adjacency: + # max_adjacency: 200 + # min_adjacency: 200 + # afi: ipv4 + # unicast: true + # auto_cost: + # reference_bandwidth: 4 + # max_metric: + # on_startup: + # time: 100 + # router_lsa: true + # process_id: 200 + # + # commands: + # - router ospfv3 200 + # - no auto-cost reference-bandwidth 4 + # - max-metric router-lsa on-startup 200 + # - area 10 nssa default-information-originate metric 10 + # - address-family ipv4 unicast + # - adjacency stagger 50 50 + # - area 200 nssa default-information-originate metric 200 nssa-only + # - exit-address-family + # + # after: + # processes: + # - address_family: + # - adjacency: + # max_adjacency: 50 + # min_adjacency: 50 + # afi: ipv4 + # areas: + # - area_id: '25' + # nssa: + # default_information_originate: + # metric: 25 + # nssa_only: true + # unicast: true + # vrf: blue + # areas: + # - area_id: '10' + # nssa: + # default_information_originate: + # metric: 10 + # max_metric: + # on_startup: + # time: 110 + # router_lsa: true + # process_id: 1 + # - address_family: + # - afi: ipv4 + # areas: + # - area_id: '200' + # nssa: + # default_information_originate: + # metric: 200 + # nssa_only: true + # unicast: true + # areas: + # - area_id: '10' + # nssa: + # default_information_originate: + # metric: 10 + # max_metric: + # on_startup: + # time: 200 + # router_lsa: true + # process_id: 200 + # # After state: # ------------- # router-ios#sh running-config | section ^router ospfv3 @@ -6940,76 +7222,47 @@ Examples config: state: gathered - # Module Execution Result: - # ------------------------ + # Task Output: + # ------------ # - # "gathered": { - # "processes": [ - # { - # "address_family": [ - # { - # "adjacency": { - # "max_adjacency": 50, - # "min_adjacency": 50 - # }, - # "afi": "ipv4", - # "areas": [ - # { - # "area_id": "25", - # "nssa": { - # "default_information_originate": { - # "metric": 25, - # "nssa_only": true - # } - # } - # } - # ], - # "unicast": true, - # "vrf": "blue" - # } - # ], - # "areas": [ - # { - # "area_id": "10", - # "nssa": { - # "default_information_originate": { - # "metric": 10 - # } - # } - # } - # ], - # "max_metric": { - # "on_startup": { - # "time": 110 - # }, - # "router_lsa": true - # }, - # "process_id": 1 - # }, - # { - # "address_family": [ - # { - # "adjacency": { - # "max_adjacency": 200, - # "min_adjacency": 200 - # }, - # "afi": "ipv4", - # "unicast": true - # } - # ], - # "auto_cost": { - # "reference_bandwidth": 4 - # }, - # "max_metric": { - # "on_startup": { - # "time": 100 - # }, - # "router_lsa": true - # }, - # "process_id": 200 - # } - # ] - # } + # parsed: + # processes: + # - address_family: + # - adjacency: + # max_adjacency: 50 + # min_adjacency: 50 + # afi: ipv4 + # areas: + # - area_id: '25' + # nssa: + # default_information_originate: + # metric: 25 + # nssa_only: true + # unicast: true + # vrf: blue + # areas: + # - area_id: '10' + # nssa: + # default_information_originate: + # metric: 10 + # max_metric: + # on_startup: + # time: 110 + # router_lsa: true + # process_id: 1 + # - address_family: + # - adjacency: + # max_adjacency: 200 + # min_adjacency: 200 + # afi: ipv4 + # unicast: true + # auto_cost: + # reference_bandwidth: 4 + # max_metric: + # on_startup: + # time: 100 + # router_lsa: true + # process_id: 200 # After state: # ------------ @@ -7081,24 +7334,24 @@ Examples reference_bandwidth: 4 state: rendered - # Module Execution Result: - # ------------------------ - # - # "rendered": [ - # "router ospfv3 1", - # "max-metric router-lsa on-startup 110", - # "area 10 nssa default-information-originate metric 10", - # "address-family ipv4 unicast vrf blue", - # "adjacency stagger 50 50", - # "area 25 nssa default-information-originate metric 25 nssa-only", - # "exit-address-family", - # "router ospfv3 200", - # "auto-cost reference-bandwidth 4", - # "max-metric router-lsa on-startup 100", - # "address-family ipv4 unicast", - # "adjacency stagger 200 200", - # "exit-address-family" - # ] + # Task Output: + # ------------ + + # rendered: + # - router ospfv3 1 + # - max-metric router-lsa on-startup 110 + # - area 10 nssa default-information-originate metric 10 + # - address-family ipv4 unicast vrf blue + # - adjacency stagger 50 50 + # - area 25 nssa default-information-originate metric 25 nssa-only + # - exit-address-family + # - router ospfv3 200 + # - auto-cost reference-bandwidth 4 + # - max-metric router-lsa on-startup 100 + # - address-family ipv4 unicast + # - adjacency stagger 200 200 + # - exit-address-family + # Using Parsed @@ -7121,59 +7374,52 @@ Examples # adjacency stagger 200 200 # exit-address-family - - name: Parse the provided configuration with the existing running configuration + - name: Parse the provided configuration and display structured ospfv3 facts. cisco.ios.ios_ospfv3: running_config: "{{ lookup('file', 'parsed.cfg') }}" state: parsed - # Module Execution Result: - # ------------------------ + # Task Output: + # ------------ # - # "parsed": { - # "processes": [ - # { - # "address_family": [ - # { - # "adjacency": { - # "max_adjacency": 50, - # "min_adjacency": 50 - # }, - # "afi": "ipv4", - # "areas": [ - # { - # "area_id": "25", - # "nssa": { - # "default_information_originate": { - # "metric": 25, - # "nssa_only": true - # } - # } - # } - # ], - # "unicast": true, - # "vrf": "blue" - # } - # ], - # "areas": [ - # { - # "area_id": "10", - # "nssa": { - # "default_information_originate": { - # "metric": 10 - # } - # } - # } - # ], - # "max_metric": { - # "on_startup": { - # "time": 110 - # }, - # "router_lsa": true - # }, - # "process_id": 1 - # } - # ] - # } + # parsed: + # processes: + # - address_family: + # - adjacency: + # max_adjacency: 50 + # min_adjacency: 50 + # afi: ipv4 + # areas: + # - area_id: '25' + # nssa: + # default_information_originate: + # metric: 25 + # nssa_only: true + # unicast: true + # vrf: blue + # areas: + # - area_id: '10' + # nssa: + # default_information_originate: + # metric: 10 + # max_metric: + # on_startup: + # time: 110 + # router_lsa: true + # process_id: 1 + # - address_family: + # - adjacency: + # max_adjacency: 200 + # min_adjacency: 200 + # afi: ipv4 + # unicast: true + # auto_cost: + # reference_bandwidth: 4 + # max_metric: + # on_startup: + # time: 100 + # router_lsa: true + # process_id: 200 @@ -7242,6 +7488,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 1', 'address-family ipv4 unicast vrf blue', 'adjacency stagger 50 50']</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 1', 'max-metric router-lsa on-startup 110', 'area 10 nssa default-information-originate metric 10']</div> + </td> + </tr> </table> <br/><br/> diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_ping_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_ping_module.rst index 209fdc24a..bce51f129 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_ping_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_ping_module.rst @@ -138,6 +138,21 @@ Parameters <tr> <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>size</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>Size of the packet to send.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>source</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_prefix_lists_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_prefix_lists_module.rst index 0f021a78e..d32f0fe87 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_prefix_lists_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_prefix_lists_module.rst @@ -348,16 +348,85 @@ Examples - name: test_prefix state: deleted - # Commands Fired: - # --------------- - # - # "commands": [ - # "no ip prefix-list 10", - # "no ip prefix-list test_prefix" - # ] + # Task Output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: this is test description + # entries: + # - action: deny + # le: 15 + # prefix: 1.0.0.0/8 + # sequence: 5 + # - action: deny + # ge: 10 + # prefix: 35.0.0.0/8 + # sequence: 10 + # - action: deny + # ge: 15 + # prefix: 12.0.0.0/8 + # sequence: 15 + # - action: deny + # ge: 20 + # le: 21 + # prefix: 14.0.0.0/8 + # sequence: 20 + # name: '10' + # - description: this is test + # entries: + # - action: deny + # ge: 15 + # prefix: 12.0.0.0/8 + # sequence: 50 + # name: test + # - description: this is for prefix-list + # entries: + # - action: deny + # ge: 10 + # le: 15 + # prefix: 35.0.0.0/8 + # sequence: 5 + # - action: deny + # ge: 20 + # prefix: 35.0.0.0/8 + # sequence: 10 + # name: test_prefix + # - afi: ipv6 + # prefix_lists: + # - description: this is ipv6 prefix-list + # entries: + # - action: deny + # ge: 80 + # prefix: 2001:DB8:0:4::/64 + # sequence: 10 + # name: test_ipv6 + # commands: + # - no ip prefix-list 10 + # - no ip prefix-list test_prefix + # after: + # - afi: ipv4 + # prefix_lists: + # - description: this is test + # entries: + # - action: deny + # ge: 15 + # prefix: 12.0.0.0/8 + # sequence: 50 + # name: test + # - afi: ipv6 + # prefix_lists: + # - description: this is ipv6 prefix-list + # entries: + # - action: deny + # ge: 80 + # prefix: 2001:DB8:0:4::/64 + # sequence: 10 + # name: test_ipv6 + # After state: - # ------------- + # ------------ # router-ios#sh running-config | section ^ip prefix-list|^ipv6 prefix-list # ip prefix-list test description this is test # ip prefix-list test seq 50 deny 12.0.0.0/8 ge 15 @@ -389,14 +458,74 @@ Examples - afi: ipv4 state: deleted - # Commands Fired: - # --------------- - # - # "commands": [ - # "no ip prefix-list test", - # "no ip prefix-list 10", - # "no ip prefix-list test_prefix" - # ] + # Task Output + # ------------- + # before: + # - afi: ipv4 + # prefix_lists: + # - description: this is test description + # entries: + # - action: deny + # le: 15 + # prefix: 1.0.0.0/8 + # sequence: 5 + # - action: deny + # ge: 10 + # prefix: 35.0.0.0/8 + # sequence: 10 + # - action: deny + # ge: 15 + # prefix: 12.0.0.0/8 + # sequence: 15 + # - action: deny + # ge: 20 + # le: 21 + # prefix: 14.0.0.0/8 + # sequence: 20 + # name: '10' + # - description: this is test + # entries: + # - action: deny + # ge: 15 + # prefix: 12.0.0.0/8 + # sequence: 50 + # name: test + # - description: this is for prefix-list + # entries: + # - action: deny + # ge: 10 + # le: 15 + # prefix: 35.0.0.0/8 + # sequence: 5 + # - action: deny + # ge: 20 + # prefix: 35.0.0.0/8 + # sequence: 10 + # name: test_prefix + # - afi: ipv6 + # prefix_lists: + # - description: this is ipv6 prefix-list + # entries: + # - action: deny + # ge: 80 + # prefix: 2001:DB8:0:4::/64 + # sequence: 10 + # name: test_ipv6 + # commands: + # - "no ip prefix-list test", + # - "no ip prefix-list 10", + # - "no ip prefix-list test_prefix" + # after: + # - afi: ipv6 + # prefix_lists: + # - description: this is ipv6 prefix-list + # entries: + # - action: deny + # ge: 80 + # prefix: 2001:DB8:0:4::/64 + # sequence: 10 + # name: test_ipv6 + # After state: # ------------- @@ -1137,4 +1266,5 @@ Status Authors ~~~~~~~ +- Sagar Paul (@KB-perByte) - Sumit Jaiswal (@justjais) diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_service_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_service_module.rst index 0156ec79c..ed859129d 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_service_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_service_module.rst @@ -1015,6 +1015,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> @@ -1023,6 +1024,7 @@ Parameters </td> <td> <div>The state the configuration should be left in.</div> + <div>The module have declaratively similar behavior for replaced and overridden state.</div> <div>Refer to examples for more details.</div> </td> </tr> @@ -1256,7 +1258,7 @@ Examples # service dhcp # service password-recovery - - name: "Delete service configuration and restore default configuration for some importants service (those with a default value in module)" + - name: "Delete service configuration and restore default configuration for some important service (those with a default value in module)" cisco.ios.ios_service: state: deleted @@ -1293,8 +1295,8 @@ Examples # prompt: true # slave_log: true - #·After·state: - #·------------ + # After state: + # ------------ # # router-ios#show running-config all | section ^service # service slave-log diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_snmp_server_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_snmp_server_module.rst index 05ab8d691..063beb6c0 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_snmp_server_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_snmp_server_module.rst @@ -604,6 +604,27 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="5"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>match</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>exact</li> + <li>prefix</li> + </ul> + </td> + <td> + <div>Specify a context name match criteria</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>notify</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -1310,6 +1331,27 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="5"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>aaa_server</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 SNMP AAA Server traps</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>auth_framework</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -1755,6 +1797,174 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="5"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>bulkstat</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>Allow Data-Collection-MIB Collection notifications</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>collection</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 Data-Collection-MIB Collection notifications</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>enable</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 Data-Collection-MIB Collection and Transfert notifications</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>transfer</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 Data-Collection-MIB Transfer notifications</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>call_home</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>SNMP CISCO-CALLHOME-MIB traps</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>enable</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 SNMP CISCO-CALLHOME-MIB traps</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>message_send_fail</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 SNMP ccmSmtpMsgSendFailNotif notification</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>server_fail</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 SNMP ccmSmtpServerFailNotif notification</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>casa</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -2218,6 +2428,217 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="5"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>entity_diag</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>Allow SNMP CISCO-ENTITY-DIAG-MIB traps</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>boot_up_fail</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 SNMP ceDiagBootUpFailedNotif traps</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>enable</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 SNMP CISCO-ENTITY-DIAG-MIB traps</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>hm_test_recover</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 SNMP ceDiagHMTestRecoverNotif traps</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>hm_thresh_reached</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 SNMP ceDiagHMThresholdReachedNotif traps</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>scheduled_test_fail</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 SNMP ceDiagScheduledTestFailedNotif traps</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>entity_perf</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>Allow SNMP CISCO-ENTITY-PERFORMANCE-MIB traps</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>enable</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 SNMP CISCO-ENTITY-PERFORMANCE-MIB traps</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>throughput_notif</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 ENTITY PERFORMANCE MIB throughput traps</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>entity_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 SNMP ENTITY-STATE-MIB traps</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>envmon</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -2227,7 +2648,7 @@ Parameters <td> </td> <td> - <div>Allow envmon related traps</div> + <div>Enable SNMP environmental monitor traps</div> </td> </tr> <tr> @@ -2236,6 +2657,28 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="4"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>enable</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 envmon traps</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>fan</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -2246,6 +2689,8 @@ Parameters </td> <td> <div>Enable SNMP envmon fan traps</div> + <div>This option is DEPRECATED and is replaced with fan_enable which accepts bool as input</div> + <div>This attribute will be removed after 2024-09-01</div> </td> </tr> <tr> @@ -2370,6 +2815,28 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="4"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>fan_enable</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 SNMP envmon fan traps</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>shutdown</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -2458,6 +2925,48 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="5"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>errdisable</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 SNMP errdisable notifications</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>ether_oam</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 SNMP ethernet oam traps</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>ethernet</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -2921,6 +3430,174 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="5"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>flash</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>SNMP FLASH notifications</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>enable</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 SNMP FLASH notifications</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>insertion</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 SNMP Flash Insertion notifications</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>lowspace</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 SNMP Flash Low Space notifications</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>removal</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 SNMP Flash Removal notifications</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>flex_links</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>SNMP FLEX Links traps</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>enable</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 SNMP FLEX Links traps</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>status</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 SNMP FLEX Links status change traps</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>flowmon</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -3531,6 +4208,90 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="5"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>l2tc</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>Allow SNMP L2 Tunnel Config traps</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>enable</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 SNMP L2 Tunnel Config traps</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>sys_threshold</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 SNMP L2TC System threshold traps</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>threshold</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 SNMP L2 Tunnel Config threshold traps</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>l2tun</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -3593,6 +4354,1232 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="5"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>license</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 license traps</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>lisp</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 SNMP LISP MIB traps</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>local_auth</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 SNMP local auth traps</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>mac_notification</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>Allow SNMP MAC Notification traps</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>change</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 SNMP MAC Change traps</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>enable</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 SNMP MAC Notification traps</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>move</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 SNMP MAC Move traps</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>threshold</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 SNMP MAC Threshold traps</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>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>Allow MEMORY traps</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>bufferpeak</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 SNMP Memory Bufferpeak traps</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>enable</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 MEMORY traps</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>mpls</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 SNMP mpls traps</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>fast_reroute</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>Allow SNMP MPLS fast reroute traps</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>enable</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 SNMP MPLS fast reroute traps</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>protected</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 MPLS fast reroute protection traps</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>ldp</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>Allow SNMP MPLS label distribution protocol traps</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>enable</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 SNMP MPLS label distribution protocol traps</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>pv_limit</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 MPLS LDP path vector limit mismatch traps</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>session_down</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 MPLS LDP session down traps</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>session_up</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 MPLS LDP session up traps</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>threshold</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 MPLS LDP threshold exceeded traps</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>rfc</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 SNMP MPLS RFC traps</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>ldp</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>Allow SNMP MPLS label distribution protocol RFC traps</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>enable</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 SNMP MPLS label distribution protocol RFC traps</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>pv_limit</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 MPLS LDP path vector limit mismatch RFC traps</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>session_down</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 MPLS LDP session down RFC traps</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>session_up</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 MPLS LDP session up RFC traps</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>threshold</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 MPLS LDP threshold exceeded RFC traps</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>traffic_eng</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>Allow SNMP MPLS traffic engineering RFC traps</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>down</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 MPLS TE tunnel down RFC traps</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>enable</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 SNMP MPLS traffic engineering RFC traps</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>reoptimized</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 MPLS TE tunnel reoptimized RFC traps</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>reroute</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 MPLS TE tunnel reroute RFC traps</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>up</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 MPLS TE tunnel up RFC traps</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>vpn</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>Allow SNMP MPLS Virtual Private Network RFC traps</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>enable</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 SNMP MPLS Virtual Private Network RFC traps</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>illegal_label</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 MPLS VPN illegal label threshold exceeded RFC traps</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>max_thresh_cleared</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 MPLS VPN maximum threshold cleared RFC traps</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>max_threshold</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 MPLS VPN maximum threshold exceeded RFC traps</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>mid_threshold</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 MPLS VPN middle threshold exceeded RFC traps</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>vrf_down</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 MPLS VPN vrf down RFC traps</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>vrf_up</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 MPLS VPN vrf up RFC traps</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>traffic_eng</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>Allow SNMP MPLS traffic engineering traps</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>down</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 MPLS TE tunnel down traps</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>enable</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 SNMP MPLS traffic engineering traps</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>reroute</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 MPLS TE tunnel reroute traps</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>up</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 MPLS TE tunnel up traps</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>vpn</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>Allow SNMP MPLS Virtual Private Network traps</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>enable</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 SNMP MPLS Virtual Private Network traps</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>illegal_label</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 MPLS VPN illegal label threshold exceeded traps</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>max_thresh_cleared</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 MPLS VPN maximum threshold cleared traps</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>max_threshold</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 MPLS VPN maximum threshold exceeded traps</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>mid_threshold</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 MPLS VPN middle threshold exceeded traps</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>vrf_down</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 MPLS VPN vrf down traps</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>vrf_up</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 MPLS VPN vrf up traps</div> + </td> + </tr> + + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>mpls_vpn</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -3607,6 +5594,8 @@ Parameters </td> <td> <div>Enable SNMP mpls traps</div> + <div>This option is DEPRECATED and is replaced with mpls which accepts dict as input</div> + <div>This attribute will be removed after 2024-09-01</div> </td> </tr> <tr> @@ -3656,6 +5645,332 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="5"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>nhrp</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>Allow SNMP NHRP traps</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>enable</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 SNMP NHRP traps</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>nhc</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>Allow Next Hop Client traps</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>down</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 Next Hop Client down trap</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>enable</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 Next Hop Client traps</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>up</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 Next Hop Client up trap</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>nhp</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>Allow Next Hop Peer traps</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>down</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 Next Hop Peer down trap</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>enable</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 Next Hop Peer traps</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>up</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 Next Hop Peer up trap</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>nhs</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>Allow Next Hop Server traps</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>down</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 Next Hop Server down trap</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>enable</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 Next Hop Server traps</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>up</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 Next Hop Server up trap</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>quota_exceeded</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 quota-exceeded trap</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>ospf</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -3965,6 +6280,403 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="5"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>ospfv3</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>Allow OSPFv3 related traps</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>errors</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>Error traps</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>bad_packet</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>Packet parse failure on non-virtual interfaces</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>config_error</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>Config mismatch errors on non-virtual interfaces</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>enable</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 Error traps</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>virt_bad_packet</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>Packet parse failure on virtual interfaces</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>virt_config_error</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>Config mismatch errors on virtual interfaces</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>rate_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>Trap rate limit values</div> + <div>Rate limit window size in seconds (between 2 and 60)</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>state_change</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>State change traps</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>enable</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 State change traps</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>if_state_change</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>Non_virtual interface state changes</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>neighbor_restart_helper_status_change</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>Neighbor graceful restart helper status changes</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>neighbor_state_change</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>Non_virtual neighbor state changes</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>nssa_translator_status_change</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>NSSA translator status changes</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>restart_status_change</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>Graceful restart status changes</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>virtif_state_change</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>Virtual interface state changes</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>vn_restart_helper_status_change</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>Virtual neighbor graceful restart helper status changes</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>vn_state_change</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>Virtual neighbor state changes</div> + </td> + </tr> + + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>pim</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -4092,6 +6804,147 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="5"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>port_security</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 SNMP port security traps</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>power_ethernet</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>Allow SNMP power ethernet traps</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>enable</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 SNMP power ethernet traps</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>group</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>Enable SNMP inline power group based traps.</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>slot_id</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>An integer between 1 and 20 (physical slot number)</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>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 level for this slot</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>police</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 Policing Trap</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>pw_vc</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -4113,6 +6966,48 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="5"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>rep</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 SNMP Resilient Ethernet Protocol Traps</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>rf</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 all SNMP traps defined in CISCO-RF-MIB</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>rsvp</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -4134,6 +7029,90 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="5"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>smart_license</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>Allow smart license traps</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>enable</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 smart license traps</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>entitlement</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 Entitlement Notification trap</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>global</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 Global Notification traps</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>snmp</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -4262,6 +7241,133 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="5"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>stackwise</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 SNMP stackwise traps</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>stpx</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>Allow SNMP STPX MIB traps</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>enable</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 SNMP STPX MIB traps</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>inconsistency</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 SNMP STPX MIB InconsistencyUpdate traps</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>loop_inconsistency</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 SNMP STPX MIB LoopInconsistencyUpdate traps</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>root_inconsistency</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 SNMP STPX MIB RootInconsistencyUpdate traps</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>syslog</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -4304,6 +7410,734 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="5"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>trustsec</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>Allow SNMP CISCO-TRUSTSEC-MIB traps</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>authz_file_error</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 ctsAuthzCacheFileErrNotif notifications</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>cache_file_error</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 ctsCacheFileAccessErrNotif notifications</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>enable</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 SNMP CISCO-TRUSTSEC-MIB traps</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>keystore_file_error</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 ctsSwKeystoreFileErrNotif notifications</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>keystore_sync_fail</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 ctsSwKeystoreSyncFailNotif notifications</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>random_number_fail</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 ctsSapRandonNumberFailNotif notifications</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>src_entropy_fail</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 ctsSrcEntropyFailNotif notifications</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>trustsec_interface</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>Allow SNMP CISCO-TRUSTSEC-INTERFACE-MIB traps</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>authc_fail</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 ctsiIfAuthenticationFailNotif trap</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>authz_fail</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 ctsiAuthorizationFailNotif trap</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>enable</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 SNMP CISCO-TRUSTSEC-INTERFACE-MIB traps</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>sap_fail</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 ctsiIfSapNegotiationFailNotif trap</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>supplicant_fail</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 ctsiIfAddSupplicantFailNotif trap</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>unauthorized</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 ctsiIfUnauthorizedNotifEnable trap</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>trustsec_policy</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>Allow SNMP CISCO-TRUSTSEC-POLICY-MIB traps</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>authz_sgacl_fail</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 ctspAuthorizationSgaclFailNotif notifications</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>enable</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 SNMP CISCO-TRUSTSEC-POLICY-MIB traps</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>peer_policy_updated</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 ctspPeerPolicyUpdatedNotif notifications</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>trustsec_server</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>Allow SNMP CISCO-TRUSTSEC-SERVER-MIB traps</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>enable</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 SNMP CISCO-TRUSTSEC-SERVER-MIB traps</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>provision_secret</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 ctsvNoProvisionSecretNotif notification</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>radius_server</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 ctsvNoRadiusServerNotif notification</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>trustsec_sxp</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>Allow SNMP CISCO-TRUSTSEC-SXP-MIB traps</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>binding_conflict</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 ctsxSxpBindingConflictNotif notifications</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>binding_err</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 ctsxSxpBindingErrNotif notifications</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>binding_expn_fail</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 ctsxSxpBindingExpnFailNotif notifications</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>conn_config_err</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 ctsxSxpConnConfigErrNotif notifications</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>conn_down</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 ctsxSxpConnDownNotif notifications</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>conn_srcaddr_err</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 ctsxSxpConnSourceAddrErrNotif notifications</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>conn_up</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 ctsxSxpConnUpNotif notifications</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>enable</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 SNMP CISCO-TRUSTSEC-SXP-MIB traps</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>msg_parse_err</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 ctsxSxpMsgParseErrNotif notifications</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>oper_nodeid_change</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 ctsxSxpOperNodeIdChangeNotif notifications</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>tty</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -4325,6 +8159,153 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="5"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>udld</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>Allow SNMP CISCO-UDLDP-MIB traps</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>enable</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 SNMP CISCO-UDLDP-MIB traps</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>link_fail_rpt</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 SNMP cudldpFastHelloLinkFailRptNotification traps</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>status_change</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 SNMP cudldpFastHelloStatusChangeNotification traps</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>vlan_membership</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 SNMP VLAN membership traps</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>vlancreate</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 SNMP VLAN created traps</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>vlandelete</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 SNMP VLAN deleted traps</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>vrfmib</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -4447,6 +8428,111 @@ Parameters <div>Enable SNMP vrrp traps</div> </td> </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>vswitch</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>Allow SNMP Virtual Switch notifications</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>dual_active</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 SNMP Virtual Switch (Dual Active) notification</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>enable</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 SNMP Virtual Switch notifications</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>vsl</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 SNMP Virtual Switch Link (VSL) notification</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>vtp</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 SNMP VTP traps</div> + </td> + </tr> <tr> <td class="elbow-placeholder"></td> @@ -5285,7 +9371,7 @@ Examples # Before state: # ------------- - #router-ios#show running-config | section ^snmp-server + # router-ios#show running-config | section ^snmp-server # snmp-server engineID remote 172.16.0.12 udp-port 25 AB0C5342FF0F # snmp-server user userPaul dev v1 access 24 # snmp-server group mergedGroup v3 auth diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_vlans_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_vlans_module.rst index 93b259513..598486c57 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_vlans_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_vlans_module.rst @@ -53,6 +53,58 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>member</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>Members of VLAN</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>evi</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>Ethernet Virtual Private Network (EVPN)</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>vni</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>VXLAN vni</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td colspan="2"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>mtu</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -221,6 +273,25 @@ Parameters <tr> <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>configuration</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>When set to true, deals with vlan configuration CLIs</div> + </td> + </tr> + <tr> + <td colspan="3"> + <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"> @@ -353,6 +424,44 @@ Examples # ------------------------------------------------------------------------------ # 10 + # Using merged (configuration: True) + + # Before state: + # ------------- + # + # Leaf-01#show run nve | sec ^vlan configuration + # vlan configuration 101 + # member evpn-instance 101 vni 10101 + # vlan configuration 201 + # member evpn-instance 201 vni 10201 + + + - name: Merge provided configuration with device configuration + cisco.ios.ios_vlans: + config: + - vlan_id: 102 + member: + vni: 10102 + evi: 102 + - vlan_id: 901 + member: + vni: 50901 + configuration: true + state: merged + + # After state: + # ------------ + # + # Leaf-01#show run nve | sec ^vlan configuration + # vlan configuration 101 + # member evpn-instance 101 vni 10101 + # vlan configuration 102 + # member evpn-instance 102 vni 10102 + # vlan configuration 201 + # member evpn-instance 201 vni 10201 + # vlan configuration 901 + # member vni 50901 + # Using overridden # Before state: @@ -415,6 +524,45 @@ Examples # 1004 fdnet 101004 1500 - - - ieee - 0 0 # 1005 trnet 101005 1500 - - - ibm - 0 0 + + # Using overridden (configuration: True) + + # Before state: + # ------------- + # + # Leaf-01#show run nve | sec ^vlan configuration + # vlan configuration 101 + # member evpn-instance 101 vni 10101 + # vlan configuration 102 + # member evpn-instance 102 vni 10102 + # vlan configuration 201 + # member evpn-instance 201 vni 10201 + # vlan configuration 901 + # member vni 50901 + + - name: Override device configuration of all VLANs with provided configuration + cisco.ios.ios_vlans: + config: + - vlan_id: 101 + member: + vni: 10102 + evi: 102 + - vlan_id: 102 + member: + vni: 10101 + evi: 101 + configuration: true + state: overridden + + # After state: + # ------------ + # + # Leaf-01#show run nve | sec ^vlan configuration + # vlan configuration 101 + # member evpn-instance 102 vni 10102 + # vlan configuration 102 + # member evpn-instance 101 vni 10101 + # Using replaced # Before state: @@ -575,8 +723,41 @@ Examples # 1004 fdnet 101004 1500 - - - ieee - 0 0 # 1005 trnet 101005 1500 - - - ibm - 0 0 + # Using deleted (configuration: True) + + # Before state: + # ------------- + # + # Leaf-01#show run nve | sec ^vlan configuration + # vlan configuration 101 + # member evpn-instance 101 vni 10101 + # vlan configuration 102 + # member evpn-instance 102 vni 10102 + # vlan configuration 201 + # member evpn-instance 201 vni 10201 + # vlan configuration 901 + # member vni 50901 + + - name: Delete attributes of given VLANs + cisco.ios.ios_vlans: + config: + - vlan_id: 101 + configuration: true + state: deleted + + # After state: + # ------------- + # + # Leaf-01#show run nve | sec ^vlan configuration + # vlan configuration 102 + # member evpn-instance 102 vni 10102 + # vlan configuration 201 + # member evpn-instance 201 vni 10201 + # vlan configuration 901 + # member vni 50901 + # Using Deleted without any config passed - #"(NOTE: This will delete all of configured vlans attributes)" + # "(NOTE: This will delete all of configured vlans attributes)" # Before state: # ------------- @@ -632,134 +813,108 @@ Examples # 1004 fdnet 101004 1500 - - - ieee - 0 0 # 1005 trnet 101005 1500 - - - ibm - 0 0 - # Using Gathered + # Using Deleted without any config passed (configuration: True) + # "(NOTE: This will delete all of configured vlans attributes)" # Before state: # ------------- # - # vios_l2#show vlan - # VLAN Name Status Ports - # ---- -------------------------------- --------- ------------------------------- - # 1 default active Gi0/1, Gi0/2 - # 10 vlan_10 active - # 20 vlan_20 act/lshut - # 30 vlan_30 sus/lshut - # 1002 fddi-default act/unsup - # 1003 token-ring-default act/unsup - # 1004 fddinet-default act/unsup - # 1005 trnet-default act/unsup + # Leaf-01#show run nve | sec ^vlan configuration + # vlan configuration 101 + # member evpn-instance 101 vni 10101 + # vlan configuration 102 + # member evpn-instance 102 vni 10102 + # vlan configuration 201 + # member evpn-instance 201 vni 10201 + # vlan configuration 202 + # member evpn-instance 202 vni 10202 + # vlan configuration 901 + # member vni 50901 + + - name: Delete attributes of ALL VLANs + cisco.ios.ios_vlans: + configuration: true + state: deleted + + # After state: + # ------------- # - # VLAN Type SAID MTU Parent RingNo BridgeNo Stp BrdgMode Trans1 Trans2 - # ---- ----- ---------- ----- ------ ------ -------- ---- -------- ------ ------ - # 1 enet 100001 1500 - - - - - 0 0 - # 10 enet 100010 1500 - - - - - 0 0 - # 20 enet 100020 610 - - - - - 0 0 - # 30 enet 100030 1500 - - - - - 0 0 - # 1002 fddi 101002 1500 - - - - - 0 0 - # 1003 tr 101003 1500 - - - - - 0 0 - # 1004 fdnet 101004 1500 - - - ieee - 0 0 - # 1005 trnet 101005 1500 - - - ibm - 0 0 + # Leaf-01#show run nve | sec ^vlan configuration + # no vlan configuration 101 + # no vlan configuration 102 + # no vlan configuration 201 + # no vlan configuration 202 + # no vlan configuration 901 + # no vlan configuration 902 + + # Using Gathered (configuration: True) + + # Before state: + # ------------- # - # Remote SPAN VLANs - # ------------------------------------------------------------------------------ - # 10 + # Leaf-01#show run nve | sec ^vlan configuration + # vlan configuration 101 + # member evpn-instance 101 vni 10101 + # vlan configuration 102 + # member evpn-instance 102 vni 10102 + # vlan configuration 201 + # member evpn-instance 201 vni 10201 + # vlan configuration 202 + # member evpn-instance 202 vni 10202 + # vlan configuration 901 + # member vni 50901 - name: Gather listed vlans with provided configurations cisco.ios.ios_vlans: config: + configuration: true state: gathered # Module Execution Result: # ------------------------ # - # "gathered": [ - # { - # "mtu": 1500, - # "name": "default", - # "shutdown": "disabled", - # "state": "active", - # "vlan_id": 1 + # gathered = [ + # { + # "member": { + # "evi": 101, + # "vni": 10101 # }, - # { - # "mtu": 1500, - # "name": "VLAN0010", - # "shutdown": "disabled", - # "state": "active", - # "vlan_id": 10 - # }, - # { - # "mtu": 1500, - # "name": "VLAN0020", - # "shutdown": "disabled", - # "state": "active", - # "vlan_id": 20 + # "vlan_id": 101 + # }, + # { + # "member": { + # "evi": 102, + # "vni": 10102 # }, - # { - # "mtu": 1500, - # "name": "VLAN0030", - # "shutdown": "disabled", - # "state": "active", - # "vlan_id": 30 + # "vlan_id": 102 + # }, + # { + # "member": { + # "evi": 201, + # "vni": 10201 # }, - # { - # "mtu": 1500, - # "name": "fddi-default", - # "shutdown": "enabled", - # "state": "active", - # "vlan_id": 1002 + # "vlan_id": 201 + # }, + # { + # "member": { + # "evi": 202, + # "vni": 10202 # }, - # { - # "mtu": 1500, - # "name": "token-ring-default", - # "shutdown": "enabled", - # "state": "active", - # "vlan_id": 1003 + # "vlan_id": 202 + # }, + # { + # "member": { + # "vni": 50901 # }, - # { - # "mtu": 1500, - # "name": "fddinet-default", - # "shutdown": "enabled", - # "state": "active", - # "vlan_id": 1004 + # "vlan_id": 901 + # }, + # { + # "member": { + # "vni": 50902 # }, - # { - # "mtu": 1500, - # "name": "trnet-default", - # "shutdown": "enabled", - # "state": "active", - # "vlan_id": 1005 - # } - # ] - - # After state: - # ------------ - # - # vios_l2#show vlan - # VLAN Name Status Ports - # ---- -------------------------------- --------- ------------------------------- - # 1 default active Gi0/1, Gi0/2 - # 10 vlan_10 active - # 20 vlan_20 act/lshut - # 30 vlan_30 sus/lshut - # 1002 fddi-default act/unsup - # 1003 token-ring-default act/unsup - # 1004 fddinet-default act/unsup - # 1005 trnet-default act/unsup - # - # VLAN Type SAID MTU Parent RingNo BridgeNo Stp BrdgMode Trans1 Trans2 - # ---- ----- ---------- ----- ------ ------ -------- ---- -------- ------ ------ - # 1 enet 100001 1500 - - - - - 0 0 - # 10 enet 100010 1500 - - - - - 0 0 - # 20 enet 100020 610 - - - - - 0 0 - # 30 enet 100030 1500 - - - - - 0 0 - # 1002 fddi 101002 1500 - - - - - 0 0 - # 1003 tr 101003 1500 - - - - - 0 0 - # 1004 fdnet 101004 1500 - - - ieee - 0 0 - # 1005 trnet 101005 1500 - - - ibm - 0 0 - # - # Remote SPAN VLANs - # ------------------------------------------------------------------------------ - # 10 + # "vlan_id": 902 + # } + # ] # Using Rendered @@ -802,6 +957,31 @@ Examples # "shutdown" # ] + # Using Rendered (configuration: True) + + - name: Render the commands for provided configuration + cisco.ios.ios_vlans: + config: + - vlan_id: 101 + member: + vni: 10101 + evi: 101 + - vlan_id: 102 + member: + vni: 10102 + evi: 102 + state: rendered + + # Module Execution Result: + # ------------------------ + # + # "rendered": [ + # "vlan configuration 101", + # "member evpn-instance 101 vni 10101", + # "vlan configuration 102", + # "member evpn-instance 102 vni 10102" + # ] + # Using Parsed # File: parsed.cfg @@ -896,6 +1076,50 @@ Examples # } # ] + # Using Parsed (configuration: True) + + # File: parsed.cfg + # ---------------- + # + # vlan configuration 101 + # member evpn-instance 101 vni 10101 + # vlan configuration 102 + # member evpn-instance 102 vni 10102 + # vlan configuration 901 + # member vni 50901 + + - name: Parse the commands for provided configuration + cisco.ios.ios_vlans: + running_config: "{{ lookup('file', './parsed.cfg') }}" + configuration: true + state: parsed + + # Module Execution Result: + # ------------------------ + # + # "parsed": [ + # { + # "member": { + # "evi": 101, + # "vni": 10101 + # }, + # "vlan_id": 101 + # }, + # { + # "member": { + # "evi": 102, + # "vni": 10102 + # }, + # "vlan_id": 102 + # }, + # { + # "member": { + # "vni": 50901 + # }, + # "vlan_id": 901 + # } + # ] + Return Values diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_vrf_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_vrf_module.rst index 1420a65fd..9223586e0 100644 --- a/ansible_collections/cisco/ios/docs/cisco.ios.ios_vrf_module.rst +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_vrf_module.rst @@ -36,6 +36,22 @@ Parameters <tr> <td colspan="1"> <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>The list of address families with MDT parameters to be configured on the remote IOS device.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>associated_interfaces</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> diff --git a/ansible_collections/cisco/ios/docs/cisco.ios.ios_vxlan_vtep_module.rst b/ansible_collections/cisco/ios/docs/cisco.ios.ios_vxlan_vtep_module.rst new file mode 100644 index 000000000..3f1abc5f5 --- /dev/null +++ b/ansible_collections/cisco/ios/docs/cisco.ios.ios_vxlan_vtep_module.rst @@ -0,0 +1,701 @@ +.. _cisco.ios.ios_vxlan_vtep_module: + + +************************ +cisco.ios.ios_vxlan_vtep +************************ + +**Resource module to configure VXLAN VTEP interface.** + + +Version added: 5.3.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module provides declarative management of VXLAN VTEP interface on Cisco IOS network devices. + + + + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="7">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="7"> + <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 VXLAN VTEP interface option</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="6"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>host_reachability_bgp</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>Host reachability using EVPN protocol</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="6"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>interface</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>VXLAN VTEP interface</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="6"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>member</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 VNI member</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="5"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>vni</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 VNI information</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>l2vni</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>Associates L2VNI with the VXLAN VTEP interface</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>replication</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>Replication type for the L2VNI</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>mcast_group</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 multicast group for VN<em>s</em></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 class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>ipv4</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>IPv4 multicast group</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 class="elbow-placeholder"></td> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>ipv6</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>IPv6 multicast group</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>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>ingress</li> + <li>static</li> + </ul> + </td> + <td> + <div>Replication type</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>vni</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>VNI 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>l3vni</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>Associates L3VNI with the VXLAN VTEP interface</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>vni</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>VNI number</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>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> + </td> + <td> + <div>VRF name of the L3VNI</div> + </td> + </tr> + + + + <tr> + <td class="elbow-placeholder"></td> + <td colspan="6"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>source_interface</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>Source interface for the VXLAN VTEP interface</div> + </td> + </tr> + + <tr> + <td colspan="7"> + <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 IOS device by executing the command <b>show running-config | section ^interface nve</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="7"> + <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>rendered</li> + <li>gathered</li> + <li>parsed</li> + </ul> + </td> + <td> + <div>The state the configuration should be left in</div> + </td> + </tr> + </table> + <br/> + + +Notes +----- + +.. note:: + - Tested against Cisco IOS device with Version 17.13.01 on Cat9k on CML. + - This module works with connection ``network_cli``. See https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html + + + +Examples +-------- + +.. code-block:: yaml + + # Using state merged + + # Before state: + # ------------- + # interface nve1 + # no ip address + # source-interface Loopback1 + # host-reachability protocol bgp + # member vni 10101 mcast-group 225.0.0.101 + # member vni 10102 ingress-replication + # member vni 50901 vrf green + # member vni 10201 mcast-group 225.0.0.101 + # member vni 10202 ingress-replication + # member vni 50902 vrf blue + + # - name: Merge the provided configuration with the device configuration + # cisco.ios.ios_vxlan_vtep: + # config: + # - interface: nve1 + # source_interface: loopback2 + # member: + # vni: + # l2vni: + # - vni: 10101 + # replication: + # type: ingress + # - vni: 10201 + # replication: + # type: static + # mcast_group: + # ipv4: 225.0.0.101 + # ipv6: FF0E:225::101 + # l3vni: + # - vni: 50901 + # vrf: blue + # state: merged + + # Commands Fired: + # --------------- + # "commands": [ + # "interface nve1", + # "source-interface loopback2", + # "no member vni 10101 mcast-group 225.0.0.101", + # "member vni 10101 ingress-replication", + # "no member vni 10201 mcast-group 225.0.0.101", + # "member vni 10201 mcast-group 225.0.0.101 FF0E:225::101", + # "no member vni 50901 vrf green", + # "no member vni 50902 vrf blue", + # "member vni 50901 vrf blue" + # ], + + # After state: + # ------------ + # interface nve1 + # no ip address + # source-interface Loopback2 + # host-reachability protocol bgp + # member vni 10102 ingress-replication + # member vni 10202 ingress-replication + # member vni 10101 ingress-replication + # member vni 10201 mcast-group 225.0.0.101 FF0E:225::101 + # member vni 50901 vrf blue + + # Using state replaced + + # Before state: + # ------------- + # interface nve1 + # no ip address + # source-interface Loopback2 + # host-reachability protocol bgp + # member vni 10102 ingress-replication + # member vni 10202 ingress-replication + # member vni 10101 ingress-replication + # member vni 10201 mcast-group 225.0.0.101 FF0E:225::101 + # member vni 50901 vrf blue + + # - name: Replaces the device configuration with the provided configuration + # cisco.ios.ios_vxlan_vtep: + # config: + # - interface: nve1 + # source_interface: Loopback2 + # member: + # vni: + # l2vni: + # - vni: 10101 + # replication: + # type: static + # mcast_group: + # ipv6: FF0E:225::101 + # - vni: 10201 + # replication: + # type: static + # mcast_group: + # ipv6: FF0E:225::102 + # state: replaced + + # Commands Fired: + # --------------- + # "commands": [ + # "interface nve1", + # "no member vni 10101 ingress-replication", + # "member vni 10101 mcast-group FF0E:225::101", + # "no member vni 10201 mcast-group 225.0.0.101 FF0E:225::101", + # "member vni 10201 mcast-group FF0E:225::102", + # "no member vni 10102 ingress-replication", + # "no member vni 10202 ingress-replication", + # "no member vni 50901 vrf blue" + # ], + + # After state: + # ------------ + # interface nve1 + # no ip address + # source-interface Loopback2 + # host-reachability protocol bgp + # member vni 10101 mcast-group FF0E:225::101 + # member vni 10201 mcast-group FF0E:225::102 + + # Using state Deleted + + # Before state: + # ------------- + # interface nve1 + # no ip address + # source-interface Loopback2 + # host-reachability protocol bgp + # member vni 10101 mcast-group FF0E:225::101 + # member vni 10201 mcast-group FF0E:225::102 + + # - name: "Delete VXLAN VTEP interface" + # cisco.ios.ios_vxlan_vtep: + # config: + # - interface: nve1 + # state: deleted + + # Commands Fired: + # --------------- + # "commands": [ + # "interface nve1", + # "no source-interface Loopback2", + # "no host-reachability protocol bgp", + # "no member vni 10101 mcast-group FF0E:225::101", + # "no member vni 10201 mcast-group FF0E:225::102" + # ], + + # After state: + # ------------- + # interface nve1 + # no ip address + + # Using state Deleted with member VNIs + + # Before state: + # ------------- + # interface nve1 + # no ip address + # source-interface Loopback2 + # host-reachability protocol bgp + # member vni 10101 mcast-group FF0E:225::101 + # member vni 10102 mcast-group 225.0.0.101 + # member vni 10201 mcast-group 225.0.0.101 FF0E:225::101 + + # - name: "Delete VXLAN VTEP interface with member VNIs" + # cisco.ios.ios_vxlan_vtep: + # config: + # - interface: nve1 + # source_interface: Loopback2 + # member: + # vni: + # l2vni: + # - vni: 10101 + # - vni: 10102 + # state: deleted + + # Commands Fired: + # --------------- + # "commands": [ + # "interface nve1", + # "no member vni 10101 mcast-group FF0E:225::101", + # "no member vni 10102 mcast-group 225.0.0.101" + # ], + + # After state: + # ------------- + # interface nve1 + # no ip address + # source-interface Loopback2 + # host-reachability protocol bgp + # member vni 10201 mcast-group 225.0.0.101 FF0E:225::101 + + # Using state Deleted with no config + + # Before state: + # ------------- + # interface nve1 + # no ip address + # source-interface Loopback2 + # host-reachability protocol bgp + # member vni 10101 mcast-group FF0E:225::101 + # member vni 10201 mcast-group FF0E:225::102 + + # - name: "Delete VXLAN VTEP interface with no config" + # cisco.ios.ios_vxlan_vtep: + # state: deleted + + # Commands Fired: + # --------------- + # "commands": [ + # "interface nve1", + # "no source-interface Loopback2", + # "no host-reachability protocol bgp", + # "no member vni 10101 mcast-group FF0E:225::101", + # "no member vni 10201 mcast-group FF0E:225::102" + # ], + + # After state: + # ------------- + # interface nve1 + # no ip address + + + +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 nve1', 'source-interface Loopback1', 'host-reachability protocol bgp', 'member vni 10101 ingress-replication']</div> + </td> + </tr> + </table> + <br/><br/> + + +Status +------ + + +Authors +~~~~~~~ + +- Padmini Priyadarshini Sivaraj (@PadminiSivaraj) |