diff --git a/docs/vyos.vyos.vyos_vrrp_module.rst b/docs/vyos.vyos.vyos_vrrp_module.rst deleted file mode 100644 index a74b0802..00000000 --- a/docs/vyos.vyos.vyos_vrrp_module.rst +++ /dev/null @@ -1,1240 +0,0 @@ -.. _vyos.vyos.vyos_vrrp_module: - - -******************* -vyos.vyos.vyos_vrrp -******************* - -**High Availability (VRRP) resource module** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manages VRRP configuration of interfaces on devices running VYOS. -- The provided examples of commands are valid for VyOS 1.4+ - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- config - -
- dictionary -
- 		- -
A dict of VRRP configuration.
-
-
- disable - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Disable instance
-
-
- running_config - -
- string -
- 		- -
This option is used only with state parsed.
-
The value of this option should be the output received from the EOS device by executing the command show running-config | section bgp.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
-
-
- state - -
- string -
- 		-
    Choices: -
  • deleted
    • -
  • merged ←
    • -
  • purged
    • -
  • replaced
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- 		-
The state the configuration should be left in.
-
State purged removes all the BGP configurations from the target device. Use caution with this state.('delete protocols bgp <x>')
-
State deleted only removes BGP attributes that this modules manages and does not negate the BGP process completely. Thereby, preserving address-family related configurations under BGP context.
-
Running states deleted and replaced will result in an error if there are address-family configuration lines present under neighbor context that is is to be removed. Please use the vyos.vyos.vyos_bgp_address_family module for prior cleanup.
-
Refer to examples for more details.
-
-
- - - - -Examples --------- - -.. code-block:: yaml - - # Using merged - # Before state - - # vyos@vyos:~$ show configuration commands | match "set protocols bgp" - # vyos@vyos:~$ - - - name: Merge provided configuration with device configuration - vyos.vyos.vyos_vrrp: - config: - as_number: "65536" - aggregate_address: - - prefix: "203.0.113.0/24" - as_set: true - - prefix: "192.0.2.0/24" - summary_only: true - network: - - address: "192.1.13.0/24" - backdoor: true - redistribute: - - protocol: "kernel" - metric: 45 - - protocol: "connected" - route_map: "map01" - maximum_paths: - - path: "ebgp" - count: 20 - - path: "ibgp" - count: 55 - timers: - keepalive: 35 - bgp_params: - bestpath: - as_path: "confed" - compare_routerid: true - default: - no_ipv4_unicast: true - router_id: "192.1.2.9" - confederation: - - peers: 20 - - peers: 55 - - identifier: 66 - neighbor: - - address: "192.0.2.25" - disable_connected_check: true - timers: - holdtime: 30 - keepalive: 10 - - address: "203.0.113.5" - attribute_unchanged: - as_path: true - med: true - ebgp_multihop: 2 - remote_as: 101 - update_source: "192.0.2.25" - - address: "5001::64" - maximum_prefix: 34 - distribute_list: - - acl: 20 - action: "export" - - acl: 40 - action: "import" - state: merged - - # After State - # vyos@vyos:~$ show configuration commands | match "set protocols bgp" - # set protocols bgp system-as 65536 - # set protocols bgp aggregate-address 192.0.2.0/24 'summary-only' - # set protocols bgp aggregate-address 203.0.113.0/24 'as-set' - # set protocols bgp maximum-paths ebgp '20' - # set protocols bgp maximum-paths ibgp '55' - # set protocols bgp neighbor 192.0.2.25 'disable-connected-check' - # set protocols bgp neighbor 192.0.2.25 timers holdtime '30' - # set protocols bgp neighbor 192.0.2.25 timers keepalive '10' - # set protocols bgp neighbor 203.0.113.5 attribute-unchanged 'as-path' - # set protocols bgp neighbor 203.0.113.5 attribute-unchanged 'med' - # set protocols bgp neighbor 203.0.113.5 attribute-unchanged 'next-hop' - # set protocols bgp neighbor 203.0.113.5 ebgp-multihop '2' - # set protocols bgp neighbor 203.0.113.5 remote-as '101' - # set protocols bgp neighbor 203.0.113.5 update-source '192.0.2.25' - # set protocols bgp neighbor 5001::64 distribute-list export '20' - # set protocols bgp neighbor 5001::64 distribute-list import '40' - # set protocols bgp neighbor 5001::64 maximum-prefix '34' - # set protocols bgp network 192.1.13.0/24 'backdoor' - # set protocols bgp parameters bestpath as-path 'confed' - # set protocols bgp parameters bestpath 'compare-routerid' - # set protocols bgp parameters confederation identifier '66' - # set protocols bgp parameters confederation peers '20' - # set protocols bgp parameters confederation peers '55' - # set protocols bgp parameters default 'no-ipv4-unicast' - # set protocols bgp parameters router-id '192.1.2.9' - # set protocols bgp redistribute connected route-map 'map01' - # set protocols bgp redistribute kernel metric '45' - # set protocols bgp timers keepalive '35' - # vyos@vyos:~$ - # - # # Module Execution: - # - # "after": { - # "aggregate_address": [ - # { - # "prefix": "192.0.2.0/24", - # "summary_only": true - # }, - # { - # "prefix": "203.0.113.0/24", - # "as_set": true - # } - # ], - # "as_number": 65536, - # "bgp_params": { - # "bestpath": { - # "as_path": "confed", - # "compare_routerid": true - # }, - # "confederation": [ - # { - # "identifier": 66 - # }, - # { - # "peers": 20 - # }, - # { - # "peers": 55 - # } - # ], - # "default": { - # "no_ipv4_unicast": true - # }, - # "router_id": "192.1.2.9" - # }, - # "maximum_paths": [ - # { - # "count": 20, - # "path": "ebgp" - # }, - # { - # "count": 55, - # "path": "ibgp" - # } - # ], - # "neighbor": [ - # { - # "address": "192.0.2.25", - # "disable_connected_check": true, - # "timers": { - # "holdtime": 30, - # "keepalive": 10 - # } - # }, - # { - # "address": "203.0.113.5", - # "attribute_unchanged": { - # "as_path": true, - # "med": true, - # "next_hop": true - # }, - # "ebgp_multihop": 2, - # "remote_as": 101, - # "update_source": "192.0.2.25" - # }, - # { - # "address": "5001::64", - # "distribute_list": [ - # { - # "acl": 20, - # "action": "export" - # }, - # { - # "acl": 40, - # "action": "import" - # } - # ], - # "maximum_prefix": 34 - # } - # ], - # "network": [ - # { - # "address": "192.1.13.0/24", - # "backdoor": true - # } - # ], - # "redistribute": [ - # { - # "protocol": "connected", - # "route_map": "map01" - # }, - # { - # "metric": 45, - # "protocol": "kernel" - # } - # ], - # "timers": { - # "keepalive": 35 - # } - # }, - # "before": {}, - # "changed": true, - # "commands": [ - # "set protocols bgp neighbor 192.0.2.25 disable-connected-check", - # "set protocols bgp neighbor 192.0.2.25 timers holdtime 30", - # "set protocols bgp neighbor 192.0.2.25 timers keepalive 10", - # "set protocols bgp neighbor 203.0.113.5 attribute-unchanged as-path", - # "set protocols bgp neighbor 203.0.113.5 attribute-unchanged med", - # "set protocols bgp neighbor 203.0.113.5 attribute-unchanged next-hop", - # "set protocols bgp neighbor 203.0.113.5 ebgp-multihop 2", - # "set protocols bgp neighbor 203.0.113.5 remote-as 101", - # "set protocols bgp neighbor 203.0.113.5 update-source 192.0.2.25", - # "set protocols bgp neighbor 5001::64 maximum-prefix 34", - # "set protocols bgp neighbor 5001::64 distribute-list export 20", - # "set protocols bgp neighbor 5001::64 distribute-list import 40", - # "set protocols bgp redistribute kernel metric 45", - # "set protocols bgp redistribute connected route-map map01", - # "set protocols bgp network 192.1.13.0/24 backdoor", - # "set protocols bgp aggregate-address 203.0.113.0/24 as-set", - # "set protocols bgp aggregate-address 192.0.2.0/24 summary-only", - # "set protocols bgp parameters bestpath as-path confed", - # "set protocols bgp parameters bestpath compare-routerid", - # "set protocols bgp parameters default no-ipv4-unicast", - # "set protocols bgp parameters router-id 192.1.2.9", - # "set protocols bgp parameters confederation peers 20", - # "set protocols bgp parameters confederation peers 55", - # "set protocols bgp parameters confederation identifier 66", - # "set protocols bgp maximum-paths ebgp 20", - # "set protocols bgp maximum-paths ibgp 55", - # "set protocols bgp timers keepalive 35" - # ], - - # Using replaced: - # -------------- - - # Before state: - - # vyos@vyos:~$ show configuration commands | match "set protocols bgp" - # set protocols bgp system-as 65536 - # set protocols bgp aggregate-address 192.0.2.0/24 'summary-only' - # set protocols bgp aggregate-address 203.0.113.0/24 'as-set' - # set protocols bgp maximum-paths ebgp '20' - # set protocols bgp maximum-paths ibgp '55' - # set protocols bgp neighbor 192.0.2.25 'disable-connected-check' - # set protocols bgp neighbor 192.0.2.25 timers holdtime '30' - # set protocols bgp neighbor 192.0.2.25 timers keepalive '10' - # set protocols bgp neighbor 203.0.113.5 attribute-unchanged 'as-path' - # set protocols bgp neighbor 203.0.113.5 attribute-unchanged 'med' - # set protocols bgp neighbor 203.0.113.5 attribute-unchanged 'next-hop' - # set protocols bgp neighbor 203.0.113.5 ebgp-multihop '2' - # set protocols bgp neighbor 203.0.113.5 remote-as '101' - # set protocols bgp neighbor 203.0.113.5 update-source '192.0.2.25' - # set protocols bgp neighbor 5001::64 distribute-list export '20' - # set protocols bgp neighbor 5001::64 distribute-list import '40' - # set protocols bgp neighbor 5001::64 maximum-prefix '34' - # set protocols bgp network 192.1.13.0/24 'backdoor' - # set protocols bgp parameters bestpath as-path 'confed' - # set protocols bgp parameters bestpath 'compare-routerid' - # set protocols bgp parameters confederation identifier '66' - # set protocols bgp parameters confederation peers '20' - # set protocols bgp parameters confederation peers '55' - # set protocols bgp parameters default 'no-ipv4-unicast' - # set protocols bgp parameters router-id '192.1.2.9' - # set protocols bgp redistribute connected route-map 'map01' - # set protocols bgp redistribute kernel metric '45' - # set protocols bgp timers keepalive '35' - # vyos@vyos:~$ - - - name: Replace - vyos.vyos.vyos_vrrp: - config: - as_number: "65536" - network: - - address: "203.0.113.0/24" - route_map: map01 - redistribute: - - protocol: "static" - route_map: "map01" - neighbor: - - address: "192.0.2.40" - advertisement_interval: 72 - capability: - orf: "receive" - bgp_params: - bestpath: - as_path: "confed" - state: replaced - # After state: - - # vyos@vyos:~$ show configuration commands | match "set protocols bgp" - # set protocols bgp system-as 65536 - # set protocols bgp neighbor 192.0.2.40 advertisement-interval '72' - # set protocols bgp neighbor 192.0.2.40 capability orf prefix-list 'receive' - # set protocols bgp network 203.0.113.0/24 route-map 'map01' - # set protocols bgp parameters bestpath as-path 'confed' - # set protocols bgp redistribute static route-map 'map01' - # vyos@vyos:~$ - # - # - # Module Execution: - # - # "after": { - # "as_number": 65536, - # "bgp_params": { - # "bestpath": { - # "as_path": "confed" - # } - # }, - # "neighbor": [ - # { - # "address": "192.0.2.40", - # "advertisement_interval": 72, - # "capability": { - # "orf": "receive" - # } - # } - # ], - # "network": [ - # { - # "address": "203.0.113.0/24", - # "route_map": "map01" - # } - # ], - # "redistribute": [ - # { - # "protocol": "static", - # "route_map": "map01" - # } - # ] - # }, - # "before": { - # "aggregate_address": [ - # { - # "prefix": "192.0.2.0/24", - # "summary_only": true - # }, - # { - # "prefix": "203.0.113.0/24", - # "as_set": true - # } - # ], - # "as_number": 65536, - # "bgp_params": { - # "bestpath": { - # "as_path": "confed", - # "compare_routerid": true - # }, - # "confederation": [ - # { - # "identifier": 66 - # }, - # { - # "peers": 20 - # }, - # { - # "peers": 55 - # } - # ], - # "default": { - # "no_ipv4_unicast": true - # }, - # "router_id": "192.1.2.9" - # }, - # "maximum_paths": [ - # { - # "count": 20, - # "path": "ebgp" - # }, - # { - # "count": 55, - # "path": "ibgp" - # } - # ], - # "neighbor": [ - # { - # "address": "192.0.2.25", - # "disable_connected_check": true, - # "timers": { - # "holdtime": 30, - # "keepalive": 10 - # } - # }, - # { - # "address": "203.0.113.5", - # "attribute_unchanged": { - # "as_path": true, - # "med": true, - # "next_hop": true - # }, - # "ebgp_multihop": 2, - # "remote_as": 101, - # "update_source": "192.0.2.25" - # }, - # { - # "address": "5001::64", - # "distribute_list": [ - # { - # "acl": 20, - # "action": "export" - # }, - # { - # "acl": 40, - # "action": "import" - # } - # ], - # "maximum_prefix": 34 - # } - # ], - # "network": [ - # { - # "address": "192.1.13.0/24", - # "backdoor": true - # } - # ], - # "redistribute": [ - # { - # "protocol": "connected", - # "route_map": "map01" - # }, - # { - # "metric": 45, - # "protocol": "kernel" - # } - # ], - # "timers": { - # "keepalive": 35 - # } - # }, - # "changed": true, - # "commands": [ - # "delete protocols bgp timers", - # "delete protocols bgp maximum-paths ", - # "delete protocols bgp maximum-paths ", - # "delete protocols bgp parameters router-id 192.1.2.9", - # "delete protocols bgp parameters default", - # "delete protocols bgp parameters confederation", - # "delete protocols bgp parameters bestpath compare-routerid", - # "delete protocols bgp aggregate-address", - # "delete protocols bgp network 192.1.13.0/24", - # "delete protocols bgp redistribute kernel", - # "delete protocols bgp redistribute kernel", - # "delete protocols bgp redistribute connected", - # "delete protocols bgp redistribute connected", - # "delete protocols bgp neighbor 5001::64", - # "delete protocols bgp neighbor 203.0.113.5", - # "delete protocols bgp neighbor 192.0.2.25", - # "set protocols bgp neighbor 192.0.2.40 advertisement-interval 72", - # "set protocols bgp neighbor 192.0.2.40 capability orf prefix-list receive", - # "set protocols bgp redistribute static route-map map01", - # "set protocols bgp network 203.0.113.0/24 route-map map01" - # ], - - # Using deleted: - # ------------- - - # Before state: - - # vyos@vyos:~$ show configuration commands | match "set protocols bgp" - # set protocols bgp system-as 65536 - # set protocols bgp neighbor 192.0.2.40 advertisement-interval '72' - # set protocols bgp neighbor 192.0.2.40 capability orf prefix-list 'receive' - # set protocols bgp network 203.0.113.0/24 route-map 'map01' - # set protocols bgp parameters bestpath as-path 'confed' - # set protocols bgp redistribute static route-map 'map01' - # vyos@vyos:~$ - - - name: Delete configuration - vyos.vyos.vyos_vrrp: - config: - as_number: "65536" - state: deleted - - # After state: - - # vyos@vyos:~$ show configuration commands | match "set protocols bgp" - # set protocols bgp '65536' - # vyos@vyos:~$ - # - # - # Module Execution: - # - # "after": { - # "as_number": 65536 - # }, - # "before": { - # "as_number": 65536, - # "bgp_params": { - # "bestpath": { - # "as_path": "confed" - # } - # }, - # "neighbor": [ - # { - # "address": "192.0.2.40", - # "advertisement_interval": 72, - # "capability": { - # "orf": "receive" - # } - # } - # ], - # "network": [ - # { - # "address": "203.0.113.0/24", - # "route_map": "map01" - # } - # ], - # "redistribute": [ - # { - # "protocol": "static", - # "route_map": "map01" - # } - # ] - # }, - # "changed": true, - # "commands": [ - # "delete protocols bgp neighbor 192.0.2.40", - # "delete protocols bgp redistribute", - # "delete protocols bgp network", - # "delete protocols bgp parameters" - # ], - - # Using purged: - - # Before state: - - # vyos@vyos:~$ show configuration commands | match "set protocols bgp" - # set protocols bgp system-as 65536 - # set protocols bgp aggregate-address 192.0.2.0/24 'summary-only' - # set protocols bgp aggregate-address 203.0.113.0/24 'as-set' - # set protocols bgp maximum-paths ebgp '20' - # set protocols bgp maximum-paths ibgp '55' - # set protocols bgp neighbor 192.0.2.25 'disable-connected-check' - # set protocols bgp neighbor 192.0.2.25 timers holdtime '30' - # set protocols bgp neighbor 192.0.2.25 timers keepalive '10' - # set protocols bgp neighbor 203.0.113.5 attribute-unchanged 'as-path' - # set protocols bgp neighbor 203.0.113.5 attribute-unchanged 'med' - # set protocols bgp neighbor 203.0.113.5 attribute-unchanged 'next-hop' - # set protocols bgp neighbor 203.0.113.5 ebgp-multihop '2' - # set protocols bgp neighbor 203.0.113.5 remote-as '101' - # set protocols bgp neighbor 203.0.113.5 update-source '192.0.2.25' - # set protocols bgp neighbor 5001::64 distribute-list export '20' - # set protocols bgp neighbor 5001::64 distribute-list import '40' - # set protocols bgp neighbor 5001::64 maximum-prefix '34' - # set protocols bgp network 192.1.13.0/24 'backdoor' - # set protocols bgp parameters bestpath as-path 'confed' - # set protocols bgp parameters bestpath 'compare-routerid' - # set protocols bgp parameters confederation identifier '66' - # set protocols bgp parameters confederation peers '20' - # set protocols bgp parameters confederation peers '55' - # set protocols bgp parameters default 'no-ipv4-unicast' - # set protocols bgp parameters router-id '192.1.2.9' - # set protocols bgp redistribute connected route-map 'map01' - # set protocols bgp redistribute kernel metric '45' - # set protocols bgp timers keepalive '35' - # vyos@vyos:~$ - - - - name: Purge configuration - vyos.vyos.vyos_vrrp: - config: - as_number: "65536" - state: purged - - # After state: - - # vyos@vyos:~$ show configuration commands | match "set protocols bgp" - # vyos@vyos:~$ - # - # Module Execution: - # - # "after": {}, - # "before": { - # "aggregate_address": [ - # { - # "prefix": "192.0.2.0/24", - # "summary_only": true - # }, - # { - # "prefix": "203.0.113.0/24", - # "as_set": true - # } - # ], - # "as_number": 65536, - # "bgp_params": { - # "bestpath": { - # "as_path": "confed", - # "compare_routerid": true - # }, - # "confederation": [ - # { - # "identifier": 66 - # }, - # { - # "peers": 20 - # }, - # { - # "peers": 55 - # } - # ], - # "default": { - # "no_ipv4_unicast": true - # }, - # "router_id": "192.1.2.9" - # }, - # "maximum_paths": [ - # { - # "count": 20, - # "path": "ebgp" - # }, - # { - # "count": 55, - # "path": "ibgp" - # } - # ], - # "neighbor": [ - # { - # "address": "192.0.2.25", - # "disable_connected_check": true, - # "timers": { - # "holdtime": 30, - # "keepalive": 10 - # } - # }, - # { - # "address": "203.0.113.5", - # "attribute_unchanged": { - # "as_path": true, - # "med": true, - # "next_hop": true - # }, - # "ebgp_multihop": 2, - # "remote_as": 101, - # "update_source": "192.0.2.25" - # }, - # { - # "address": "5001::64", - # "distribute_list": [ - # { - # "acl": 20, - # "action": "export" - # }, - # { - # "acl": 40, - # "action": "import" - # } - # ], - # "maximum_prefix": 34 - # } - # ], - # "network": [ - # { - # "address": "192.1.13.0/24", - # "backdoor": true - # } - # ], - # "redistribute": [ - # { - # "protocol": "connected", - # "route_map": "map01" - # }, - # { - # "metric": 45, - # "protocol": "kernel" - # } - # ], - # "timers": { - # "keepalive": 35 - # } - # }, - # "changed": true, - # "commands": [ - # "delete protocols bgp 65536" - # ], - - - # Deleted in presence of address family under neighbors: - - # Before state: - # vyos@vyos:~$ show configuration commands | match "set protocols bgp" - # set protocols bgp system-as 65536 - # set protocols bgp neighbor 192.0.2.43 advertisement-interval '72' - # set protocols bgp neighbor 192.0.2.43 capability 'dynamic' - # set protocols bgp neighbor 192.0.2.43 'disable-connected-check' - # set protocols bgp neighbor 192.0.2.43 timers holdtime '30' - # set protocols bgp neighbor 192.0.2.43 timers keepalive '10' - # set protocols bgp neighbor 203.0.113.0 address-family 'ipv6-unicast' - # set protocols bgp neighbor 203.0.113.0 capability orf prefix-list 'receive' - # set protocols bgp network 203.0.113.0/24 route-map 'map01' - # set protocols bgp parameters 'always-compare-med' - # set protocols bgp parameters bestpath as-path 'confed' - # set protocols bgp parameters bestpath 'compare-routerid' - # set protocols bgp parameters dampening half-life '33' - # set protocols bgp parameters dampening max-suppress-time '20' - # set protocols bgp parameters dampening re-use '60' - # set protocols bgp parameters dampening start-suppress-time '5' - # set protocols bgp parameters default 'no-ipv4-unicast' - # set protocols bgp parameters distance global external '66' - # set protocols bgp parameters distance global internal '20' - # set protocols bgp parameters distance global local '10' - # set protocols bgp redistribute static route-map 'map01' - # vyos@vyos:~$ ^C - # vyos@vyos:~$ - - - name: Delete configuration - vyos.vyos.vyos_vrrp: - config: - as_number: "65536" - state: deleted - - # Module Execution: - # - # "changed": false, - # "invocation": { - # "module_args": { - # "config": { - # "aggregate_address": null, - # "as_number": 65536, - # "bgp_params": null, - # "maximum_paths": null, - # "neighbor": null, - # "network": null, - # "redistribute": null, - # "timers": null - # }, - # "running_config": null, - # "state": "deleted" - # } - # }, - # "msg": "Use the _bgp_address_family module to delete the address_family under neighbor 203.0.113.0, before replacing/deleting the neighbor." - # } - - # using gathered: - # -------------- - - # Before state: - # vyos@vyos:~$ show configuration commands | match "set protocols bgp" - # set protocols bgp system-as 65536 - # set protocols bgp neighbor 192.0.2.43 advertisement-interval '72' - # set protocols bgp neighbor 192.0.2.43 capability 'dynamic' - # set protocols bgp neighbor 192.0.2.43 'disable-connected-check' - # set protocols bgp neighbor 192.0.2.43 timers holdtime '30' - # set protocols bgp neighbor 192.0.2.43 timers keepalive '10' - # set protocols bgp neighbor 203.0.113.0 address-family 'ipv6-unicast' - # set protocols bgp neighbor 203.0.113.0 capability orf prefix-list 'receive' - # set protocols bgp network 203.0.113.0/24 route-map 'map01' - # set protocols bgp parameters 'always-compare-med' - # set protocols bgp parameters bestpath as-path 'confed' - # set protocols bgp parameters bestpath 'compare-routerid' - # set protocols bgp parameters dampening half-life '33' - # set protocols bgp parameters dampening max-suppress-time '20' - # set protocols bgp parameters dampening re-use '60' - # set protocols bgp parameters dampening start-suppress-time '5' - # set protocols bgp parameters default 'no-ipv4-unicast' - # set protocols bgp parameters distance global external '66' - # set protocols bgp parameters distance global internal '20' - # set protocols bgp parameters distance global local '10' - # set protocols bgp redistribute static route-map 'map01' - # vyos@vyos:~$ ^C - - - name: gather configs - vyos.vyos.vyos_vrrp: - state: gathered - - # Module Execution: - # "gathered": { - # "as_number": 65536, - # "bgp_params": { - # "always_compare_med": true, - # "bestpath": { - # "as_path": "confed", - # "compare_routerid": true - # }, - # "default": { - # "no_ipv4_unicast": true - # }, - # "distance": [ - # { - # "type": "external", - # "value": 66 - # }, - # { - # "type": "internal", - # "value": 20 - # }, - # { - # "type": "local", - # "value": 10 - # } - # ] - # }, - # "neighbor": [ - # { - # "address": "192.0.2.43", - # "advertisement_interval": 72, - # "capability": { - # "dynamic": true - # }, - # "disable_connected_check": true, - # "timers": { - # "holdtime": 30, - # "keepalive": 10 - # } - # }, - # { - # "address": "203.0.113.0", - # "capability": { - # "orf": "receive" - # } - # } - # ], - # "network": [ - # { - # "address": "203.0.113.0/24", - # "route_map": "map01" - # } - # ], - # "redistribute": [ - # { - # "protocol": "static", - # "route_map": "map01" - # } - # ] - # }, - # - - # Using parsed: - # ------------ - - # parsed.cfg - - # set protocols bgp neighbor 192.0.2.43 advertisement-interval '72' - # set protocols bgp neighbor 192.0.2.43 capability 'dynamic' - # set protocols bgp neighbor 192.0.2.43 'disable-connected-check' - # set protocols bgp neighbor 192.0.2.43 timers holdtime '30' - # set protocols bgp neighbor 192.0.2.43 timers keepalive '10' - # set protocols bgp neighbor 203.0.113.0 address-family 'ipv6-unicast' - # set protocols bgp neighbor 203.0.113.0 capability orf prefix-list 'receive' - # set protocols bgp network 203.0.113.0/24 route-map 'map01' - # set protocols bgp parameters 'always-compare-med' - # set protocols bgp parameters bestpath as-path 'confed' - # set protocols bgp parameters bestpath 'compare-routerid' - # set protocols bgp parameters dampening half-life '33' - # set protocols bgp parameters dampening max-suppress-time '20' - # set protocols bgp parameters dampening re-use '60' - # set protocols bgp parameters dampening start-suppress-time '5' - # set protocols bgp parameters default 'no-ipv4-unicast' - # set protocols bgp parameters distance global external '66' - # set protocols bgp parameters distance global internal '20' - # set protocols bgp parameters distance global local '10' - # set protocols bgp redistribute static route-map 'map01' - - - name: parse configs - vyos.vyos.vyos_vrrp: - running_config: "{{ lookup('file', './parsed.cfg') }}" - state: parsed - tags: - - parsed - - # Module execution: - # "parsed": { - # "as_number": 65536, - # "bgp_params": { - # "always_compare_med": true, - # "bestpath": { - # "as_path": "confed", - # "compare_routerid": true - # }, - # "default": { - # "no_ipv4_unicast": true - # }, - # "distance": [ - # { - # "type": "external", - # "value": 66 - # }, - # { - # "type": "internal", - # "value": 20 - # }, - # { - # "type": "local", - # "value": 10 - # } - # ] - # }, - # "neighbor": [ - # { - # "address": "192.0.2.43", - # "advertisement_interval": 72, - # "capability": { - # "dynamic": true - # }, - # "disable_connected_check": true, - # "timers": { - # "holdtime": 30, - # "keepalive": 10 - # } - # }, - # { - # "address": "203.0.113.0", - # "capability": { - # "orf": "receive" - # } - # } - # ], - # "network": [ - # { - # "address": "203.0.113.0/24", - # "route_map": "map01" - # } - # ], - # "redistribute": [ - # { - # "protocol": "static", - # "route_map": "map01" - # } - # ] - # } - # - - # Using rendered: - # -------------- - - - name: Render - vyos.vyos.vyos_vrrp: - config: - as_number: "65536" - network: - - address: "203.0.113.0/24" - route_map: map01 - redistribute: - - protocol: "static" - route_map: "map01" - bgp_params: - always_compare_med: true - dampening: - start_suppress_time: 5 - max_suppress_time: 20 - half_life: 33 - re_use: 60 - distance: - - type: "internal" - value: 20 - - type: "local" - value: 10 - - type: "external" - value: 66 - bestpath: - as_path: "confed" - compare_routerid: true - default: - no_ipv4_unicast: true - neighbor: - - address: "192.0.2.43" - disable_connected_check: true - advertisement_interval: 72 - capability: - dynamic: true - timers: - holdtime: 30 - keepalive: 10 - - address: "203.0.113.0" - capability: - orf: "receive" - state: rendered - - # Module Execution: - # "rendered": [ - # "set protocols bgp neighbor 192.0.2.43 disable-connected-check", - # "set protocols bgp neighbor 192.0.2.43 advertisement-interval 72", - # "set protocols bgp neighbor 192.0.2.43 capability dynamic", - # "set protocols bgp neighbor 192.0.2.43 timers holdtime 30", - # "set protocols bgp neighbor 192.0.2.43 timers keepalive 10", - # "set protocols bgp neighbor 203.0.113.0 capability orf prefix-list receive", - # "set protocols bgp redistribute static route-map map01", - # "set protocols bgp network 203.0.113.0/24 route-map map01", - # "set protocols bgp parameters always-compare-med", - # "set protocols bgp parameters dampening half-life 33", - # "set protocols bgp parameters dampening max-suppress-time 20", - # "set protocols bgp parameters dampening re-use 60", - # "set protocols bgp parameters dampening start-suppress-time 5", - # "set protocols bgp parameters distance global internal 20", - # "set protocols bgp parameters distance global local 10", - # "set protocols bgp parameters distance global external 66", - # "set protocols bgp parameters bestpath as-path confed", - # "set protocols bgp parameters bestpath compare-routerid", - # "set protocols bgp parameters default no-ipv4-unicast" - # ] - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- after - -
- dictionary -
- 		when changed -
The resulting configuration after module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- before - -
- dictionary -
- 		when state is merged, replaced, overridden, deleted or purged -
The configuration prior to the module execution.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- commands - -
- list -
- 		when state is merged, replaced, overridden, deleted or purged -
The set of commands pushed to the remote device.
-
-
Sample:
-
['set protocols bgp redistribute static route-map map01', 'set protocols bgp network 203.0.113.0/24 route-map map01', 'set protocols bgp parameters always-compare-med']
-
-
- gathered - -
- list -
- 		when state is gathered -
Facts about the network resource gathered from the remote device as structured data.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- parsed - -
- list -
- 		when state is parsed -
The device native config provided in running_config option parsed into structured data as per module argspec.
-
-
Sample:
-
This output will always be in the same format as the module argspec.
-
-
- rendered - -
- list -
- 		when state is rendered -
The provided configuration in the task rendered in device-native format (offline).
-
-
Sample:
-
['set protocols bgp redistribute static route-map map01', 'set protocols bgp network 203.0.113.0/24 route-map map01', 'set protocols bgp parameters always-compare-med']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Evgeny Molotkov (@omnom62) diff --git a/tests/sanity/ignore-2.20.txt.bak b/tests/sanity/ignore-2.20.txt.bak deleted file mode 100644 index b2139bc6..00000000 --- a/tests/sanity/ignore-2.20.txt.bak +++ /dev/null @@ -1,2 +0,0 @@ -plugins/action/vyos.py action-plugin-docs # base class for deprecated network platform modules using `connection: local` -* ansible-bad-import-from