From 28efa456c13b8c241a195dffb0a12167c8900934 Mon Sep 17 00:00:00 2001 From: GomathiselviS Date: Mon, 1 Mar 2021 23:13:13 -0500 Subject: VYOS release 2.0.0 doc update (#127) VYOS release 2.0.0 doc update Reviewed-by: https://github.com/apps/ansible-zuul --- README.md | 6 +- changelogs/CHANGELOG.rst | 31 + changelogs/changelog.yaml | 32 + changelogs/fragments/120-remove-ipaddress.yaml | 3 - changelogs/fragments/122-rpc-unbloat.yaml | 3 - .../fragments/bgp_global_resource_module.yaml | 3 - .../fragments/fix_docker_sanity_test_failures.yaml | 3 - .../modify_resource_module_class_import.yaml | 3 - changelogs/fragments/single_user_mode.yaml | 4 - .../fragments/vyos_config_diff_doc_update.yaml | 4 - docs/vyos.vyos.vyos_banner_module.rst | 2 +- docs/vyos.vyos.vyos_bgp_global_module.rst | 3079 ++++++++++++++++++++ docs/vyos.vyos.vyos_cliconf.rst | 36 + docs/vyos.vyos.vyos_command_module.rst | 2 +- docs/vyos.vyos.vyos_config_module.rst | 9 +- docs/vyos.vyos.vyos_facts_module.rst | 2 +- docs/vyos.vyos.vyos_firewall_global_module.rst | 2 +- docs/vyos.vyos.vyos_firewall_interfaces_module.rst | 2 +- docs/vyos.vyos.vyos_firewall_rules_module.rst | 2 +- docs/vyos.vyos.vyos_interface_module.rst | 2 +- docs/vyos.vyos.vyos_interfaces_module.rst | 2 +- docs/vyos.vyos.vyos_l3_interface_module.rst | 6 +- docs/vyos.vyos.vyos_l3_interfaces_module.rst | 2 +- docs/vyos.vyos.vyos_lag_interfaces_module.rst | 2 +- docs/vyos.vyos.vyos_linkagg_module.rst | 2 +- docs/vyos.vyos.vyos_lldp_global_module.rst | 2 +- docs/vyos.vyos.vyos_lldp_interface_module.rst | 2 +- docs/vyos.vyos.vyos_lldp_interfaces_module.rst | 2 +- docs/vyos.vyos.vyos_lldp_module.rst | 2 +- docs/vyos.vyos.vyos_logging_module.rst | 2 +- docs/vyos.vyos.vyos_ospf_interfaces_module.rst | 2 +- docs/vyos.vyos.vyos_ospfv2_module.rst | 2 +- docs/vyos.vyos.vyos_ospfv3_module.rst | 2 +- docs/vyos.vyos.vyos_ping_module.rst | 4 +- docs/vyos.vyos.vyos_static_route_module.rst | 2 +- docs/vyos.vyos.vyos_static_routes_module.rst | 2 +- docs/vyos.vyos.vyos_system_module.rst | 2 +- docs/vyos.vyos.vyos_user_module.rst | 2 +- docs/vyos.vyos.vyos_vlan_module.rst | 2 +- galaxy.yml | 2 +- 40 files changed, 3215 insertions(+), 61 deletions(-) delete mode 100644 changelogs/fragments/120-remove-ipaddress.yaml delete mode 100644 changelogs/fragments/122-rpc-unbloat.yaml delete mode 100644 changelogs/fragments/bgp_global_resource_module.yaml delete mode 100644 changelogs/fragments/fix_docker_sanity_test_failures.yaml delete mode 100644 changelogs/fragments/modify_resource_module_class_import.yaml delete mode 100644 changelogs/fragments/single_user_mode.yaml delete mode 100644 changelogs/fragments/vyos_config_diff_doc_update.yaml create mode 100644 docs/vyos.vyos.vyos_bgp_global_module.rst diff --git a/README.md b/README.md index 2bd45657..de197983 100644 --- a/README.md +++ b/README.md @@ -33,14 +33,11 @@ Name | Description Name | Description --- | --- -### Inventory plugins -Name | Description ---- | --- - ### Modules Name | Description --- | --- [vyos.vyos.vyos_banner](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_banner_module.rst)|Manage multiline banners on VyOS devices +[vyos.vyos.vyos_bgp_global](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_bgp_global_module.rst)|BGP Global Resource Module. [vyos.vyos.vyos_command](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_command_module.rst)|Run one or more commands on VyOS devices [vyos.vyos.vyos_config](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_config_module.rst)|Manage VyOS configuration on remote device [vyos.vyos.vyos_facts](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_facts_module.rst)|Get facts about vyos devices. @@ -68,6 +65,7 @@ Name | Description [vyos.vyos.vyos_user](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_user_module.rst)|Manage the collection of local users on VyOS device [vyos.vyos.vyos_vlan](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_vlan_module.rst)|Manage VLANs on VyOS network devices + Click the ``Content`` button to see the list of content included in this collection. diff --git a/changelogs/CHANGELOG.rst b/changelogs/CHANGELOG.rst index f0ec9956..13e20ff4 100644 --- a/changelogs/CHANGELOG.rst +++ b/changelogs/CHANGELOG.rst @@ -5,6 +5,37 @@ Vyos Collection Release Notes .. contents:: Topics +v2.0.0 +====== + +Major Changes +------------- + +- Requires ansible.netcommon v2.0.0+ to support `ansible_network_single_user_mode` and `ansible_network_import_modules` +- Please refer to ansible.netcommon `changelog `_ for more details. +- ipaddress is no longer in ansible.netcommon. For Python versions without ipaddress (< 3.0), the ipaddress package is now required. + +Minor Changes +------------- + +- Add support for configuration caching (single_user_mode). +- Add vyos BGP global resource module.(https://github.com/ansible-collections/vyos.vyos/pull/125). +- Re-use device_info dictionary in cliconf. + +Bugfixes +-------- + +- Update docs to clarify the idemptonecy releated caveat and add it in the output warnings (https://github.com/ansible-collections/ansible.netcommon/pull/189) +- cliconf plugin - Prevent `get_capabilities()` from getting larger every time it is called + +New Modules +----------- + +ansible.collections.ansible_collections.vyos.vyos.plugins.modules +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- vyos_bgp_global - BGP Global Resource Module. + v1.1.1 ====== diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index e1b3bc64..6b10f2d1 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -172,3 +172,35 @@ releases: - config-processed-as-command.yaml - galaxy-version.yaml release_date: '2021-01-27' + 2.0.0: + changes: + bugfixes: + - Update docs to clarify the idemptonecy releated caveat and add it in the output + warnings (https://github.com/ansible-collections/ansible.netcommon/pull/189) + - cliconf plugin - Prevent `get_capabilities()` from getting larger every time + it is called + major_changes: + - Requires ansible.netcommon v2.0.0+ to support `ansible_network_single_user_mode` + and `ansible_network_import_modules` + - Please refer to ansible.netcommon `changelog `_ + for more details. + - ipaddress is no longer in ansible.netcommon. For Python versions without ipaddress + (< 3.0), the ipaddress package is now required. + minor_changes: + - Add support for configuration caching (single_user_mode). + - Add vyos BGP global resource module.(https://github.com/ansible-collections/vyos.vyos/pull/125). + - Re-use device_info dictionary in cliconf. + fragments: + - 120-remove-ipaddress.yaml + - 122-rpc-unbloat.yaml + - bgp_global_resource_module.yaml + - fix_docker_sanity_test_failures.yaml + - major_release_2.0.0.yaml + - modify_resource_module_class_import.yaml + - single_user_mode.yaml + - vyos_config_diff_doc_update.yaml + modules: + - description: BGP Global Resource Module. + name: vyos_bgp_global + namespace: .ansible.collections.ansible_collections.vyos.vyos.plugins.modules + release_date: '2021-02-24' diff --git a/changelogs/fragments/120-remove-ipaddress.yaml b/changelogs/fragments/120-remove-ipaddress.yaml deleted file mode 100644 index 71dc3422..00000000 --- a/changelogs/fragments/120-remove-ipaddress.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -major_changes: - - ipaddress is no longer in ansible.netcommon. For Python versions without ipaddress (< 3.0), the ipaddress package is now required. diff --git a/changelogs/fragments/122-rpc-unbloat.yaml b/changelogs/fragments/122-rpc-unbloat.yaml deleted file mode 100644 index 0bee3e8e..00000000 --- a/changelogs/fragments/122-rpc-unbloat.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -bugfixes: - - cliconf plugin - Prevent `get_capabilities()` from getting larger every time it is called diff --git a/changelogs/fragments/bgp_global_resource_module.yaml b/changelogs/fragments/bgp_global_resource_module.yaml deleted file mode 100644 index 4d19b12c..00000000 --- a/changelogs/fragments/bgp_global_resource_module.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - Add vyos BGP global resource module.(https://github.com/ansible-collections/vyos.vyos/pull/125). diff --git a/changelogs/fragments/fix_docker_sanity_test_failures.yaml b/changelogs/fragments/fix_docker_sanity_test_failures.yaml deleted file mode 100644 index 3f02049a..00000000 --- a/changelogs/fragments/fix_docker_sanity_test_failures.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -trivial: - - Fix failures in test-sanity-docker (https://github.com/ansible-collections/arista.eos/pull/172). diff --git a/changelogs/fragments/modify_resource_module_class_import.yaml b/changelogs/fragments/modify_resource_module_class_import.yaml deleted file mode 100644 index ba948467..00000000 --- a/changelogs/fragments/modify_resource_module_class_import.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -trivial: - - Modify import of resource_module class in unit tests. diff --git a/changelogs/fragments/single_user_mode.yaml b/changelogs/fragments/single_user_mode.yaml deleted file mode 100644 index 596b899b..00000000 --- a/changelogs/fragments/single_user_mode.yaml +++ /dev/null @@ -1,4 +0,0 @@ ---- -minor_changes: - - Add support for configuration caching (single_user_mode). - - Re-use device_info dictionary in cliconf. diff --git a/changelogs/fragments/vyos_config_diff_doc_update.yaml b/changelogs/fragments/vyos_config_diff_doc_update.yaml deleted file mode 100644 index a8d26e9b..00000000 --- a/changelogs/fragments/vyos_config_diff_doc_update.yaml +++ /dev/null @@ -1,4 +0,0 @@ ---- -bugfixes: - - Update docs to clarify the idemptonecy releated caveat and add it in the output warnings - (https://github.com/ansible-collections/ansible.netcommon/pull/189) diff --git a/docs/vyos.vyos.vyos_banner_module.rst b/docs/vyos.vyos.vyos_banner_module.rst index d046cc4d..8e14ce3c 100644 --- a/docs/vyos.vyos.vyos_banner_module.rst +++ b/docs/vyos.vyos.vyos_banner_module.rst @@ -220,7 +220,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja - name: configure the pre-login banner vyos.vyos.vyos_banner: diff --git a/docs/vyos.vyos.vyos_bgp_global_module.rst b/docs/vyos.vyos.vyos_bgp_global_module.rst new file mode 100644 index 00000000..939352fb --- /dev/null +++ b/docs/vyos.vyos.vyos_bgp_global_module.rst @@ -0,0 +1,3079 @@ +.. _vyos.vyos.vyos_bgp_global_module: + + +************************* +vyos.vyos.vyos_bgp_global +************************* + +**BGP Global Resource Module.** + + +Version added: 2.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module manages BGP global configuration of interfaces on devices running VYOS. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ config + +
+ dictionary +
+ 		+ +
A dict of BGP global configuration for interfaces.
+
+
+ aggregate_address + +
+ list + / elements=dictionary +
+ 		+ +
BGP aggregate network.
+
+
+ as_set + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Generate AS-set path information for this aggregate address.
+
+
+ prefix + +
+ string +
+ 		+ +
BGP aggregate network.
+
+
+ summary_only + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Announce the aggregate summary network only.
+
+
+ as_number + +
+ integer +
+ 		+ +
AS number.
+
+
+ bgp_params + +
+ dictionary +
+ 		+ +
BGP parameters
+
+
+ always_compare_med + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Always compare MEDs from different neighbors
+
+
+ bestpath + +
+ dictionary +
+ 		+ +
Default bestpath selection mechanism
+
+
+ as_path + +
+ string +
+ 		+
    Choices: +
  • confed
    • +
  • ignore
    • +
+ 		+
AS-path attribute comparison parameters
+
+
+ compare_routerid + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare the router-id for identical EBGP paths
+
+
+ med + +
+ string +
+ 		+
    Choices: +
  • confed
    • +
  • missing-as-worst
    • +
+ 		+
MED attribute comparison parameters
+
+
+ cluster_id + +
+ string +
+ 		+ +
Route-reflector cluster-id
+
+
+ confederation + +
+ list + / elements=dictionary +
+ 		+ +
AS confederation parameters
+
+
+ identifier + +
+ integer +
+ 		+ +
Confederation AS identifier
+
+
+ peers + +
+ integer +
+ 		+ +
Peer ASs in the BGP confederation
+
+
+ dampening + +
+ dictionary +
+ 		+ +
Enable route-flap dampening
+
+
+ half_life + +
+ integer +
+ 		+ +
Half-life penalty in seconds
+
+
+ max_suppress_time + +
+ integer +
+ 		+ +
Maximum duration to suppress a stable route
+
+
+ re_use + +
+ integer +
+ 		+ +
Time to start reusing a route
+
+
+ start_suppress_time + +
+ integer +
+ 		+ +
When to start suppressing a route
+
+
+ default + +
+ dictionary +
+ 		+ +
BGP defaults
+
+
+ local_pref + +
+ integer +
+ 		+ +
Default local preference
+
+
+ no_ipv4_unicast + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Deactivate IPv4 unicast for a peer by default
+
+
+ deterministic_med + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Compare MEDs between different peers in the same AS
+
+
+ disable_network_import_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable IGP route check for network statements
+
+
+ distance + +
+ list + / elements=dictionary +
+ 		+ +
Administratives distances for BGP routes
+
+
+ prefix + +
+ integer +
+ 		+ +
Administrative distance for a specific BGP prefix
+
+
+ type + +
+ string +
+ 		+
    Choices: +
  • external
    • +
  • internal
    • +
  • local
    • +
+ 		+
Type of route
+
+
+ value + +
+ integer +
+ 		+ +
distance
+
+
+ enforce_first_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Require first AS in the path to match peer's AS
+
+
+ graceful_restart + +
+ integer +
+ 		+ +
Maximum time to hold onto restarting peer's stale paths
+
+
+ log_neighbor_changes + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Log neighbor up/down changes and reset reason
+
+
+ no_client_to_client_reflection + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable client to client route reflection
+
+
+ no_fast_external_failover + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable immediate sesison reset if peer's connected link goes down
+
+
+ router_id + +
+ string +
+ 		+ +
BGP router-id
+
+
+ scan_time + +
+ integer +
+ 		+ +
BGP route scanner interval
+
+
+ maximum_paths + +
+ list + / elements=dictionary +
+ 		+ +
BGP multipaths
+
+
+ count + +
+ integer +
+ 		+ +
No. of paths.
+
+
+ path + +
+ string +
+ 		+ +
BGP multipaths
+
+
+ neighbor + +
+ list + / elements=dictionary +
+ 		+ +
BGP neighbor
+
+
+ address + +
+ string +
+ 		+ +
BGP neighbor address (v4/v6).
+
+
+ advertisement_interval + +
+ integer +
+ 		+ +
Minimum interval for sending routing updates.
+
+
+ allowas_in + +
+ integer +
+ 		+ +
Number of occurrences of AS number.
+
+
+ as_override + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
AS for routes sent to this neighbor to be the local AS.
+
+
+ attribute_unchanged + +
+ dictionary +
+ 		+ +
BGP attributes are sent unchanged.
+
+
+ as_path + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
as_path
+
+
+ med + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
med
+
+
+ next_hop + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
next_hop
+
+
+ capability + +
+ dictionary +
+ 		+ +
Advertise capabilities to this neighbor.
+
+
+ dynamic + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Advertise dynamic capability to this neighbor.
+
+
+ orf + +
+ string +
+ 		+
    Choices: +
  • send
    • +
  • receive
    • +
+ 		+
Advertise ORF capability to this neighbor.
+
+
+ default_originate + +
+ string +
+ 		+ +
Send default route to this neighbor
+
+
+ description + +
+ string +
+ 		+ +
description text
+
+
+ disable_capability_negotiation + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disbale capability negotiation with the neighbor
+
+
+ disable_connected_check + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Disable check to see if EBGP peer's address is a connected route.
+
+
+ disable_send_community + +
+ string +
+ 		+
    Choices: +
  • extended
    • +
  • standard
    • +
+ 		+
Disable sending community attributes to this neighbor.
+
+
+ distribute_list + +
+ list + / elements=dictionary +
+ 		+ +
Access-list to filter route updates to/from this neighbor.
+
+
+ acl + +
+ integer +
+ 		+ +
Acess-list number.
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • export
    • +
  • import
    • +
+ 		+
Access-list to filter outgoing/incoming route updates to this neighbor
+
+
+ ebgp_multihop + +
+ integer +
+ 		+ +
Allow this EBGP neighbor to not be on a directly connected network. Specify the number hops.
+
+
+ filter_list + +
+ list + / elements=dictionary +
+ 		+ +
As-path-list to filter route updates to/from this neighbor.
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • export
    • +
  • import
    • +
+ 		+
filter outgoing/incoming route updates
+
+
+ path_list + +
+ string +
+ 		+ +
As-path-list to filter
+
+
+ local_as + +
+ integer +
+ 		+ +
local as number not to be prepended to updates from EBGP peers
+
+
+ maximum_prefix + +
+ integer +
+ 		+ +
Maximum number of prefixes to accept from this neighbor nexthop-self Nexthop for routes sent to this neighbor to be the local router.
+
+
+ nexthop_self + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Nexthop for routes sent to this neighbor to be the local router.
+
+
+ override_capability + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Ignore capability negotiation with specified neighbor.
+
+
+ passive + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Do not initiate a session with this neighbor
+
+
+ password + +
+ string +
+ 		+ +
BGP MD5 password
+
+
+ peer_group + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
True if all the configs unde this neighbor key is for peer group template.
+
+
+ peer_group_name + +
+ string +
+ 		+ +
IPv4 peer group for this peer
+
+
+ port + +
+ integer +
+ 		+ +
Neighbor's BGP port
+
+
+ prefix_list + +
+ list + / elements=dictionary +
+ 		+ +
Prefix-list to filter route updates to/from this neighbor.
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • export
    • +
  • import
    • +
+ 		+
filter outgoing/incoming route updates
+
+
+ prefix_list + +
+ string +
+ 		+ +
Prefix-list to filter
+
+
+ remote_as + +
+ integer +
+ 		+ +
Neighbor BGP AS number
+
+
+ remove_private_as + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Remove private AS numbers from AS path in outbound route updates
+
+
+ route_map + +
+ list + / elements=dictionary +
+ 		+ +
Route-map to filter route updates to/from this neighbor.
+
+
+ action + +
+ string +
+ 		+
    Choices: +
  • export
    • +
  • import
    • +
+ 		+
filter outgoing/incoming route updates
+
+
+ route_map + +
+ string +
+ 		+ +
route-map to filter
+
+
+ route_reflector_client + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor as a route reflector client
+
+
+ route_server_client + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Neighbor is route server client
+
+
+ shutdown + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Administratively shut down neighbor
+
+
+ soft_reconfiguration + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Soft reconfiguration for neighbor
+
+
+ strict_capability_match + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable strict capability negotiation
+
+
+ timers + +
+ dictionary +
+ 		+ +
Neighbor timers
+
+
+ connect + +
+ integer +
+ 		+ +
BGP connect timer for this neighbor.
+
+
+ holdtime + +
+ integer +
+ 		+ +
BGP hold timer for this neighbor
+
+
+ keepalive + +
+ integer +
+ 		+ +
BGP keepalive interval for this neighbor
+
+
+ ttl_security + +
+ integer +
+ 		+ +
Ttl security mechanism for this BGP peer
+
+
+ unsuppress_map + +
+ string +
+ 		+ +
Route-map to selectively unsuppress suppressed routes
+
+
+ update_source + +
+ string +
+ 		+ +
Source IP of routing updates
+
+
+ weight + +
+ integer +
+ 		+ +
Default weight for routes from this neighbor
+
+
+ network + +
+ list + / elements=dictionary +
+ 		+ +
BGP network
+
+
+ address + +
+ string +
+ 		+ +
BGP network address
+
+
+ backdoor + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Network as a backdoor route
+
+
+ route_map + +
+ string +
+ 		+ +
Route-map to modify route attributes
+
+
+ redistribute + +
+ list + / elements=dictionary +
+ 		+ +
Redistribute routes from other protocols into BGP
+
+
+ metric + +
+ integer +
+ 		+ +
Metric for redistributed routes.
+
+
+ protocol + +
+ string +
+ 		+
    Choices: +
  • connected
    • +
  • kernel
    • +
  • ospf
    • +
  • rip
    • +
  • static
    • +
+ 		+
types of routes to be redistributed.
+
+
+ route_map + +
+ string +
+ 		+ +
Route map to filter redistributed routes
+
+
+ timers + +
+ dictionary +
+ 		+ +
BGP protocol timers
+
+
+ holdtime + +
+ integer +
+ 		+ +
Hold time interval
+
+
+ keepalive + +
+ integer +
+ 		+ +
Keepalive interval
+
+
+ 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+jinja + + # 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_bgp_global: + 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 65536 aggregate-address 192.0.2.0/24 'summary-only' + # set protocols bgp 65536 aggregate-address 203.0.113.0/24 'as-set' + # set protocols bgp 65536 maximum-paths ebgp '20' + # set protocols bgp 65536 maximum-paths ibgp '55' + # set protocols bgp 65536 neighbor 192.0.2.25 'disable-connected-check' + # set protocols bgp 65536 neighbor 192.0.2.25 timers holdtime '30' + # set protocols bgp 65536 neighbor 192.0.2.25 timers keepalive '10' + # set protocols bgp 65536 neighbor 203.0.113.5 attribute-unchanged 'as-path' + # set protocols bgp 65536 neighbor 203.0.113.5 attribute-unchanged 'med' + # set protocols bgp 65536 neighbor 203.0.113.5 attribute-unchanged 'next-hop' + # set protocols bgp 65536 neighbor 203.0.113.5 ebgp-multihop '2' + # set protocols bgp 65536 neighbor 203.0.113.5 remote-as '101' + # set protocols bgp 65536 neighbor 203.0.113.5 update-source '192.0.2.25' + # set protocols bgp 65536 neighbor 5001::64 distribute-list export '20' + # set protocols bgp 65536 neighbor 5001::64 distribute-list import '40' + # set protocols bgp 65536 neighbor 5001::64 maximum-prefix '34' + # set protocols bgp 65536 network 192.1.13.0/24 'backdoor' + # set protocols bgp 65536 parameters bestpath as-path 'confed' + # set protocols bgp 65536 parameters bestpath 'compare-routerid' + # set protocols bgp 65536 parameters confederation identifier '66' + # set protocols bgp 65536 parameters confederation peers '20' + # set protocols bgp 65536 parameters confederation peers '55' + # set protocols bgp 65536 parameters default 'no-ipv4-unicast' + # set protocols bgp 65536 parameters router-id '192.1.2.9' + # set protocols bgp 65536 redistribute connected route-map 'map01' + # set protocols bgp 65536 redistribute kernel metric '45' + # set protocols bgp 65536 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 65536 neighbor 192.0.2.25 disable-connected-check", + # "set protocols bgp 65536 neighbor 192.0.2.25 timers holdtime 30", + # "set protocols bgp 65536 neighbor 192.0.2.25 timers keepalive 10", + # "set protocols bgp 65536 neighbor 203.0.113.5 attribute-unchanged as-path", + # "set protocols bgp 65536 neighbor 203.0.113.5 attribute-unchanged med", + # "set protocols bgp 65536 neighbor 203.0.113.5 attribute-unchanged next-hop", + # "set protocols bgp 65536 neighbor 203.0.113.5 ebgp-multihop 2", + # "set protocols bgp 65536 neighbor 203.0.113.5 remote-as 101", + # "set protocols bgp 65536 neighbor 203.0.113.5 update-source 192.0.2.25", + # "set protocols bgp 65536 neighbor 5001::64 maximum-prefix 34", + # "set protocols bgp 65536 neighbor 5001::64 distribute-list export 20", + # "set protocols bgp 65536 neighbor 5001::64 distribute-list import 40", + # "set protocols bgp 65536 redistribute kernel metric 45", + # "set protocols bgp 65536 redistribute connected route-map map01", + # "set protocols bgp 65536 network 192.1.13.0/24 backdoor", + # "set protocols bgp 65536 aggregate-address 203.0.113.0/24 as-set", + # "set protocols bgp 65536 aggregate-address 192.0.2.0/24 summary-only", + # "set protocols bgp 65536 parameters bestpath as-path confed", + # "set protocols bgp 65536 parameters bestpath compare-routerid", + # "set protocols bgp 65536 parameters default no-ipv4-unicast", + # "set protocols bgp 65536 parameters router-id 192.1.2.9", + # "set protocols bgp 65536 parameters confederation peers 20", + # "set protocols bgp 65536 parameters confederation peers 55", + # "set protocols bgp 65536 parameters confederation identifier 66", + # "set protocols bgp 65536 maximum-paths ebgp 20", + # "set protocols bgp 65536 maximum-paths ibgp 55", + # "set protocols bgp 65536 timers keepalive 35" + # ], + + # Using replaced: + # -------------- + + # Before state: + + # vyos@vyos:~$ show configuration commands | match "set protocols bgp" + # set protocols bgp 65536 aggregate-address 192.0.2.0/24 'summary-only' + # set protocols bgp 65536 aggregate-address 203.0.113.0/24 'as-set' + # set protocols bgp 65536 maximum-paths ebgp '20' + # set protocols bgp 65536 maximum-paths ibgp '55' + # set protocols bgp 65536 neighbor 192.0.2.25 'disable-connected-check' + # set protocols bgp 65536 neighbor 192.0.2.25 timers holdtime '30' + # set protocols bgp 65536 neighbor 192.0.2.25 timers keepalive '10' + # set protocols bgp 65536 neighbor 203.0.113.5 attribute-unchanged 'as-path' + # set protocols bgp 65536 neighbor 203.0.113.5 attribute-unchanged 'med' + # set protocols bgp 65536 neighbor 203.0.113.5 attribute-unchanged 'next-hop' + # set protocols bgp 65536 neighbor 203.0.113.5 ebgp-multihop '2' + # set protocols bgp 65536 neighbor 203.0.113.5 remote-as '101' + # set protocols bgp 65536 neighbor 203.0.113.5 update-source '192.0.2.25' + # set protocols bgp 65536 neighbor 5001::64 distribute-list export '20' + # set protocols bgp 65536 neighbor 5001::64 distribute-list import '40' + # set protocols bgp 65536 neighbor 5001::64 maximum-prefix '34' + # set protocols bgp 65536 network 192.1.13.0/24 'backdoor' + # set protocols bgp 65536 parameters bestpath as-path 'confed' + # set protocols bgp 65536 parameters bestpath 'compare-routerid' + # set protocols bgp 65536 parameters confederation identifier '66' + # set protocols bgp 65536 parameters confederation peers '20' + # set protocols bgp 65536 parameters confederation peers '55' + # set protocols bgp 65536 parameters default 'no-ipv4-unicast' + # set protocols bgp 65536 parameters router-id '192.1.2.9' + # set protocols bgp 65536 redistribute connected route-map 'map01' + # set protocols bgp 65536 redistribute kernel metric '45' + # set protocols bgp 65536 timers keepalive '35' + # vyos@vyos:~$ + + - name: Replace + vyos.vyos.vyos_bgp_global: + 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 65536 neighbor 192.0.2.40 advertisement-interval '72' + # set protocols bgp 65536 neighbor 192.0.2.40 capability orf prefix-list 'receive' + # set protocols bgp 65536 network 203.0.113.0/24 route-map 'map01' + # set protocols bgp 65536 parameters bestpath as-path 'confed' + # set protocols bgp 65536 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 65536 timers", + # "delete protocols bgp 65536 maximum-paths ", + # "delete protocols bgp 65536 maximum-paths ", + # "delete protocols bgp 65536 parameters router-id 192.1.2.9", + # "delete protocols bgp 65536 parameters default", + # "delete protocols bgp 65536 parameters confederation", + # "delete protocols bgp 65536 parameters bestpath compare-routerid", + # "delete protocols bgp 65536 aggregate-address", + # "delete protocols bgp 65536 network 192.1.13.0/24", + # "delete protocols bgp 65536 redistribute kernel", + # "delete protocols bgp 65536 redistribute kernel", + # "delete protocols bgp 65536 redistribute connected", + # "delete protocols bgp 65536 redistribute connected", + # "delete protocols bgp 65536 neighbor 5001::64", + # "delete protocols bgp 65536 neighbor 203.0.113.5", + # "delete protocols bgp 65536 neighbor 192.0.2.25", + # "set protocols bgp 65536 neighbor 192.0.2.40 advertisement-interval 72", + # "set protocols bgp 65536 neighbor 192.0.2.40 capability orf prefix-list receive", + # "set protocols bgp 65536 redistribute static route-map map01", + # "set protocols bgp 65536 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 65536 neighbor 192.0.2.40 advertisement-interval '72' + # set protocols bgp 65536 neighbor 192.0.2.40 capability orf prefix-list 'receive' + # set protocols bgp 65536 network 203.0.113.0/24 route-map 'map01' + # set protocols bgp 65536 parameters bestpath as-path 'confed' + # set protocols bgp 65536 redistribute static route-map 'map01' + # vyos@vyos:~$ + + - name: Delete configuration + vyos.vyos.vyos_bgp_global: + 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 65536 neighbor 192.0.2.40", + # "delete protocols bgp 65536 redistribute", + # "delete protocols bgp 65536 network", + # "delete protocols bgp 65536 parameters" + # ], + + # Using purged: + + # Before state: + + # vyos@vyos:~$ show configuration commands | match "set protocols bgp" + # set protocols bgp 65536 aggregate-address 192.0.2.0/24 'summary-only' + # set protocols bgp 65536 aggregate-address 203.0.113.0/24 'as-set' + # set protocols bgp 65536 maximum-paths ebgp '20' + # set protocols bgp 65536 maximum-paths ibgp '55' + # set protocols bgp 65536 neighbor 192.0.2.25 'disable-connected-check' + # set protocols bgp 65536 neighbor 192.0.2.25 timers holdtime '30' + # set protocols bgp 65536 neighbor 192.0.2.25 timers keepalive '10' + # set protocols bgp 65536 neighbor 203.0.113.5 attribute-unchanged 'as-path' + # set protocols bgp 65536 neighbor 203.0.113.5 attribute-unchanged 'med' + # set protocols bgp 65536 neighbor 203.0.113.5 attribute-unchanged 'next-hop' + # set protocols bgp 65536 neighbor 203.0.113.5 ebgp-multihop '2' + # set protocols bgp 65536 neighbor 203.0.113.5 remote-as '101' + # set protocols bgp 65536 neighbor 203.0.113.5 update-source '192.0.2.25' + # set protocols bgp 65536 neighbor 5001::64 distribute-list export '20' + # set protocols bgp 65536 neighbor 5001::64 distribute-list import '40' + # set protocols bgp 65536 neighbor 5001::64 maximum-prefix '34' + # set protocols bgp 65536 network 192.1.13.0/24 'backdoor' + # set protocols bgp 65536 parameters bestpath as-path 'confed' + # set protocols bgp 65536 parameters bestpath 'compare-routerid' + # set protocols bgp 65536 parameters confederation identifier '66' + # set protocols bgp 65536 parameters confederation peers '20' + # set protocols bgp 65536 parameters confederation peers '55' + # set protocols bgp 65536 parameters default 'no-ipv4-unicast' + # set protocols bgp 65536 parameters router-id '192.1.2.9' + # set protocols bgp 65536 redistribute connected route-map 'map01' + # set protocols bgp 65536 redistribute kernel metric '45' + # set protocols bgp 65536 timers keepalive '35' + # vyos@vyos:~$ + + + - name: Purge configuration + vyos.vyos.vyos_bgp_global: + 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 65536 neighbor 192.0.2.43 advertisement-interval '72' + # set protocols bgp 65536 neighbor 192.0.2.43 capability 'dynamic' + # set protocols bgp 65536 neighbor 192.0.2.43 'disable-connected-check' + # set protocols bgp 65536 neighbor 192.0.2.43 timers holdtime '30' + # set protocols bgp 65536 neighbor 192.0.2.43 timers keepalive '10' + # set protocols bgp 65536 neighbor 203.0.113.0 address-family 'ipv6-unicast' + # set protocols bgp 65536 neighbor 203.0.113.0 capability orf prefix-list 'receive' + # set protocols bgp 65536 network 203.0.113.0/24 route-map 'map01' + # set protocols bgp 65536 parameters 'always-compare-med' + # set protocols bgp 65536 parameters bestpath as-path 'confed' + # set protocols bgp 65536 parameters bestpath 'compare-routerid' + # set protocols bgp 65536 parameters dampening half-life '33' + # set protocols bgp 65536 parameters dampening max-suppress-time '20' + # set protocols bgp 65536 parameters dampening re-use '60' + # set protocols bgp 65536 parameters dampening start-suppress-time '5' + # set protocols bgp 65536 parameters default 'no-ipv4-unicast' + # set protocols bgp 65536 parameters distance global external '66' + # set protocols bgp 65536 parameters distance global internal '20' + # set protocols bgp 65536 parameters distance global local '10' + # set protocols bgp 65536 redistribute static route-map 'map01' + # vyos@vyos:~$ ^C + # vyos@vyos:~$ + + + - name: Delete configuration + vyos.vyos.vyos_bgp_global: + 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 65536 neighbor 192.0.2.43 advertisement-interval '72' + # set protocols bgp 65536 neighbor 192.0.2.43 capability 'dynamic' + # set protocols bgp 65536 neighbor 192.0.2.43 'disable-connected-check' + # set protocols bgp 65536 neighbor 192.0.2.43 timers holdtime '30' + # set protocols bgp 65536 neighbor 192.0.2.43 timers keepalive '10' + # set protocols bgp 65536 neighbor 203.0.113.0 address-family 'ipv6-unicast' + # set protocols bgp 65536 neighbor 203.0.113.0 capability orf prefix-list 'receive' + # set protocols bgp 65536 network 203.0.113.0/24 route-map 'map01' + # set protocols bgp 65536 parameters 'always-compare-med' + # set protocols bgp 65536 parameters bestpath as-path 'confed' + # set protocols bgp 65536 parameters bestpath 'compare-routerid' + # set protocols bgp 65536 parameters dampening half-life '33' + # set protocols bgp 65536 parameters dampening max-suppress-time '20' + # set protocols bgp 65536 parameters dampening re-use '60' + # set protocols bgp 65536 parameters dampening start-suppress-time '5' + # set protocols bgp 65536 parameters default 'no-ipv4-unicast' + # set protocols bgp 65536 parameters distance global external '66' + # set protocols bgp 65536 parameters distance global internal '20' + # set protocols bgp 65536 parameters distance global local '10' + # set protocols bgp 65536 redistribute static route-map 'map01' + # vyos@vyos:~$ ^C + + - name: gather configs + vyos.vyos.vyos_bgp_global: + 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 65536 neighbor 192.0.2.43 advertisement-interval '72' + # set protocols bgp 65536 neighbor 192.0.2.43 capability 'dynamic' + # set protocols bgp 65536 neighbor 192.0.2.43 'disable-connected-check' + # set protocols bgp 65536 neighbor 192.0.2.43 timers holdtime '30' + # set protocols bgp 65536 neighbor 192.0.2.43 timers keepalive '10' + # set protocols bgp 65536 neighbor 203.0.113.0 address-family 'ipv6-unicast' + # set protocols bgp 65536 neighbor 203.0.113.0 capability orf prefix-list 'receive' + # set protocols bgp 65536 network 203.0.113.0/24 route-map 'map01' + # set protocols bgp 65536 parameters 'always-compare-med' + # set protocols bgp 65536 parameters bestpath as-path 'confed' + # set protocols bgp 65536 parameters bestpath 'compare-routerid' + # set protocols bgp 65536 parameters dampening half-life '33' + # set protocols bgp 65536 parameters dampening max-suppress-time '20' + # set protocols bgp 65536 parameters dampening re-use '60' + # set protocols bgp 65536 parameters dampening start-suppress-time '5' + # set protocols bgp 65536 parameters default 'no-ipv4-unicast' + # set protocols bgp 65536 parameters distance global external '66' + # set protocols bgp 65536 parameters distance global internal '20' + # set protocols bgp 65536 parameters distance global local '10' + # set protocols bgp 65536 redistribute static route-map 'map01' + + - name: parse configs + vyos.vyos.vyos_bgp_global: + 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_bgp_global: + 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 65536 neighbor 192.0.2.43 disable-connected-check", + # "set protocols bgp 65536 neighbor 192.0.2.43 advertisement-interval 72", + # "set protocols bgp 65536 neighbor 192.0.2.43 capability dynamic", + # "set protocols bgp 65536 neighbor 192.0.2.43 timers holdtime 30", + # "set protocols bgp 65536 neighbor 192.0.2.43 timers keepalive 10", + # "set protocols bgp 65536 neighbor 203.0.113.0 capability orf prefix-list receive", + # "set protocols bgp 65536 redistribute static route-map map01", + # "set protocols bgp 65536 network 203.0.113.0/24 route-map map01", + # "set protocols bgp 65536 parameters always-compare-med", + # "set protocols bgp 65536 parameters dampening half-life 33", + # "set protocols bgp 65536 parameters dampening max-suppress-time 20", + # "set protocols bgp 65536 parameters dampening re-use 60", + # "set protocols bgp 65536 parameters dampening start-suppress-time 5", + # "set protocols bgp 65536 parameters distance global internal 20", + # "set protocols bgp 65536 parameters distance global local 10", + # "set protocols bgp 65536 parameters distance global external 66", + # "set protocols bgp 65536 parameters bestpath as-path confed", + # "set protocols bgp 65536 parameters bestpath compare-routerid", + # "set protocols bgp 65536 parameters default no-ipv4-unicast" + # ] + + + + +Status +------ + + +Authors +~~~~~~~ + +- Gomathi Selvi Srinivasan (@GomathiselviS) diff --git a/docs/vyos.vyos.vyos_cliconf.rst b/docs/vyos.vyos.vyos_cliconf.rst index f4543224..508a6614 100644 --- a/docs/vyos.vyos.vyos_cliconf.rst +++ b/docs/vyos.vyos.vyos_cliconf.rst @@ -22,6 +22,42 @@ Synopsis +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + +
ParameterChoices/DefaultsConfigurationComments
+
+ config_commands + +
+ list +
+
added in 2.0.0
+ 		+ Default:
[]
+ 		+
var: ansible_vyos_config_commands
+ 		+
Specifies a list of commands that can make configuration changes to the target device.
+
When `ansible_network_single_user_mode` is enabled, if a command sent to the device is present in this list, the existing cache is invalidated.
+
+
+ diff --git a/docs/vyos.vyos.vyos_command_module.rst b/docs/vyos.vyos.vyos_command_module.rst index 36ae7643..41041bc1 100644 --- a/docs/vyos.vyos.vyos_command_module.rst +++ b/docs/vyos.vyos.vyos_command_module.rst @@ -255,7 +255,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja - name: show configuration on ethernet devices eth0 and eth1 vyos.vyos.vyos_command: diff --git a/docs/vyos.vyos.vyos_config_module.rst b/docs/vyos.vyos.vyos_config_module.rst index d6f2f6bb..539f2270 100644 --- a/docs/vyos.vyos.vyos_config_module.rst +++ b/docs/vyos.vyos.vyos_config_module.rst @@ -128,7 +128,7 @@ Parameters -
The config argument specifies the base configuration to use to compare against the desired configuration. If this value is not specified, the module will automatically retrieve the current active configuration from the remote device.
+
The config argument specifies the base configuration to use to compare against the desired configuration. If this value is not specified, the module will automatically retrieve the current active configuration from the remote device. The configuration lines in the option value should be similar to how it will appear if present in the running-configuration of the device including indentation to ensure idempotency and correct diff.
@@ -144,7 +144,7 @@ Parameters -
The ordered set of configuration lines to be managed and compared with the existing configuration on the remote device.
+
The ordered set of commands that should be configured in the section. The commands must be the exact same commands as found in the device running-config as found in the device running-config to ensure idempotency and correct diff. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser.
@@ -313,7 +313,7 @@ Parameters -
The src argument specifies the path to the source config file to load. The source config file can either be in bracket format or set format. The source file can include Jinja2 template variables.
+
The src argument specifies the path to the source config file to load. The source config file can either be in bracket format or set format. The source file can include Jinja2 template variables. The configuration lines in the source file should be similar to how it will appear if present in the running-configuration of the device including indentation to ensure idempotency and correct diff.
@@ -326,6 +326,7 @@ Notes .. note:: - Tested against VyOS 1.1.8 (helium). - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - To ensure idempotency and correct diff the configuration lines in the relevant module options should be similar to how they appear if present in the running configuration on device including the indentation. - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` @@ -333,7 +334,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja - name: configure the remote device vyos.vyos.vyos_config: diff --git a/docs/vyos.vyos.vyos_facts_module.rst b/docs/vyos.vyos.vyos_facts_module.rst index 3177888b..d2858640 100644 --- a/docs/vyos.vyos.vyos_facts_module.rst +++ b/docs/vyos.vyos.vyos_facts_module.rst @@ -199,7 +199,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja # Gather all facts - vyos.vyos.vyos_facts: diff --git a/docs/vyos.vyos.vyos_firewall_global_module.rst b/docs/vyos.vyos.vyos_firewall_global_module.rst index b37cf020..30f7ecf1 100644 --- a/docs/vyos.vyos.vyos_firewall_global_module.rst +++ b/docs/vyos.vyos.vyos_firewall_global_module.rst @@ -783,7 +783,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja # Using merged # diff --git a/docs/vyos.vyos.vyos_firewall_interfaces_module.rst b/docs/vyos.vyos.vyos_firewall_interfaces_module.rst index 8a18fc61..7c55b045 100644 --- a/docs/vyos.vyos.vyos_firewall_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_firewall_interfaces_module.rst @@ -216,7 +216,7 @@ Parameters Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja # Using merged # diff --git a/docs/vyos.vyos.vyos_firewall_rules_module.rst b/docs/vyos.vyos.vyos_firewall_rules_module.rst index cebe64cc..15073b1e 100644 --- a/docs/vyos.vyos.vyos_firewall_rules_module.rst +++ b/docs/vyos.vyos.vyos_firewall_rules_module.rst @@ -1327,7 +1327,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja # Using deleted to delete firewall rules based on rule-set name # diff --git a/docs/vyos.vyos.vyos_interface_module.rst b/docs/vyos.vyos.vyos_interface_module.rst index 46af72db..111ff311 100644 --- a/docs/vyos.vyos.vyos_interface_module.rst +++ b/docs/vyos.vyos.vyos_interface_module.rst @@ -572,7 +572,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja - name: configure interface vyos.vyos.vyos_interface: diff --git a/docs/vyos.vyos.vyos_interfaces_module.rst b/docs/vyos.vyos.vyos_interfaces_module.rst index 52ae1ccc..5bf5d231 100644 --- a/docs/vyos.vyos.vyos_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_interfaces_module.rst @@ -319,7 +319,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja # Using merged # diff --git a/docs/vyos.vyos.vyos_l3_interface_module.rst b/docs/vyos.vyos.vyos_l3_interface_module.rst index 8c76dcb8..7193a016 100644 --- a/docs/vyos.vyos.vyos_l3_interface_module.rst +++ b/docs/vyos.vyos.vyos_l3_interface_module.rst @@ -322,7 +322,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja - name: Set eth0 IPv4 address vyos.vyos.vyos_l3_interface: @@ -338,13 +338,13 @@ Examples vyos.vyos.vyos_l3_interface: aggregate: - {name: eth1, ipv4: 192.168.2.10/24} - - {name: eth2, ipv4: 192.168.3.10/24, ipv6: fd5d:12c9:2201:1::1/64} + - {name: eth2, ipv4: 192.168.3.10/24, ipv6: "fd5d:12c9:2201:1::1/64"} - name: Remove IP addresses on aggregate vyos.vyos.vyos_l3_interface: aggregate: - {name: eth1, ipv4: 192.168.2.10/24} - - {name: eth2, ipv4: 192.168.3.10/24, ipv6: fd5d:12c9:2201:1::1/64} + - {name: eth2, ipv4: 192.168.3.10/24, ipv6: "fd5d:12c9:2201:1::1/64"} state: absent diff --git a/docs/vyos.vyos.vyos_l3_interfaces_module.rst b/docs/vyos.vyos.vyos_l3_interfaces_module.rst index 94b3d585..38dd3e91 100644 --- a/docs/vyos.vyos.vyos_l3_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_l3_interfaces_module.rst @@ -303,7 +303,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja # Using merged # diff --git a/docs/vyos.vyos.vyos_lag_interfaces_module.rst b/docs/vyos.vyos.vyos_lag_interfaces_module.rst index 52da8678..153e20e2 100644 --- a/docs/vyos.vyos.vyos_lag_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_lag_interfaces_module.rst @@ -273,7 +273,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja # Using merged # diff --git a/docs/vyos.vyos.vyos_linkagg_module.rst b/docs/vyos.vyos.vyos_linkagg_module.rst index f7586d65..ae7eea7b 100644 --- a/docs/vyos.vyos.vyos_linkagg_module.rst +++ b/docs/vyos.vyos.vyos_linkagg_module.rst @@ -348,7 +348,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja - name: configure link aggregation group vyos.vyos.vyos_linkagg: diff --git a/docs/vyos.vyos.vyos_lldp_global_module.rst b/docs/vyos.vyos.vyos_lldp_global_module.rst index 851ed202..92244211 100644 --- a/docs/vyos.vyos.vyos_lldp_global_module.rst +++ b/docs/vyos.vyos.vyos_lldp_global_module.rst @@ -180,7 +180,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja # Using merged # diff --git a/docs/vyos.vyos.vyos_lldp_interface_module.rst b/docs/vyos.vyos.vyos_lldp_interface_module.rst index 01036649..1c860e7d 100644 --- a/docs/vyos.vyos.vyos_lldp_interface_module.rst +++ b/docs/vyos.vyos.vyos_lldp_interface_module.rst @@ -264,7 +264,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja - name: Enable LLDP on eth1 net_lldp_interface: diff --git a/docs/vyos.vyos.vyos_lldp_interfaces_module.rst b/docs/vyos.vyos.vyos_lldp_interfaces_module.rst index 030cd734..c5ea47bc 100644 --- a/docs/vyos.vyos.vyos_lldp_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_lldp_interfaces_module.rst @@ -370,7 +370,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja # Using merged # diff --git a/docs/vyos.vyos.vyos_lldp_module.rst b/docs/vyos.vyos.vyos_lldp_module.rst index 88d0211c..92aa732e 100644 --- a/docs/vyos.vyos.vyos_lldp_module.rst +++ b/docs/vyos.vyos.vyos_lldp_module.rst @@ -209,7 +209,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja - name: Enable LLDP service vyos.vyos.vyos_lldp: diff --git a/docs/vyos.vyos.vyos_logging_module.rst b/docs/vyos.vyos.vyos_logging_module.rst index 9cb024d0..f651b7a5 100644 --- a/docs/vyos.vyos.vyos_logging_module.rst +++ b/docs/vyos.vyos.vyos_logging_module.rst @@ -360,7 +360,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja - name: configure console logging vyos.vyos.vyos_logging: diff --git a/docs/vyos.vyos.vyos_ospf_interfaces_module.rst b/docs/vyos.vyos.vyos_ospf_interfaces_module.rst index 0417088c..141c0cf3 100644 --- a/docs/vyos.vyos.vyos_ospf_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_ospf_interfaces_module.rst @@ -461,7 +461,7 @@ Parameters Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja # Using merged # diff --git a/docs/vyos.vyos.vyos_ospfv2_module.rst b/docs/vyos.vyos.vyos_ospfv2_module.rst index 9433538e..50ed5d34 100644 --- a/docs/vyos.vyos.vyos_ospfv2_module.rst +++ b/docs/vyos.vyos.vyos_ospfv2_module.rst @@ -1649,7 +1649,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja # Using merged # diff --git a/docs/vyos.vyos.vyos_ospfv3_module.rst b/docs/vyos.vyos.vyos_ospfv3_module.rst index 568dbabe..d1ee1b18 100644 --- a/docs/vyos.vyos.vyos_ospfv3_module.rst +++ b/docs/vyos.vyos.vyos_ospfv3_module.rst @@ -348,7 +348,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja # Using merged # diff --git a/docs/vyos.vyos.vyos_ping_module.rst b/docs/vyos.vyos.vyos_ping_module.rst index f9c4a681..e3377fc5 100644 --- a/docs/vyos.vyos.vyos_ping_module.rst +++ b/docs/vyos.vyos.vyos_ping_module.rst @@ -284,7 +284,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja - name: Test reachability to 10.10.10.10 vyos.vyos.vyos_ping: @@ -405,7 +405,7 @@ Common return values are documented `here The round trip time (RTT) stats.
Sample:
-
{'avg': 2, 'max': 8, 'min': 1, 'mdev': 24}
+
AnsibleMapping([('avg', 2), ('max', 8), ('min', 1), ('mdev', 24)])
diff --git a/docs/vyos.vyos.vyos_static_route_module.rst b/docs/vyos.vyos.vyos_static_route_module.rst index 69afb568..74f296d4 100644 --- a/docs/vyos.vyos.vyos_static_route_module.rst +++ b/docs/vyos.vyos.vyos_static_route_module.rst @@ -354,7 +354,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja - name: configure static route vyos.vyos.vyos_static_route: diff --git a/docs/vyos.vyos.vyos_static_routes_module.rst b/docs/vyos.vyos.vyos_static_routes_module.rst index 5a6884b1..53942a5c 100644 --- a/docs/vyos.vyos.vyos_static_routes_module.rst +++ b/docs/vyos.vyos.vyos_static_routes_module.rst @@ -343,7 +343,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja # Using merged # diff --git a/docs/vyos.vyos.vyos_system_module.rst b/docs/vyos.vyos.vyos_system_module.rst index bc521f07..a71303c4 100644 --- a/docs/vyos.vyos.vyos_system_module.rst +++ b/docs/vyos.vyos.vyos_system_module.rst @@ -248,7 +248,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja - name: configure hostname and domain-name vyos.vyos.vyos_system: diff --git a/docs/vyos.vyos.vyos_user_module.rst b/docs/vyos.vyos.vyos_user_module.rst index f47ab015..04a7a6e2 100644 --- a/docs/vyos.vyos.vyos_user_module.rst +++ b/docs/vyos.vyos.vyos_user_module.rst @@ -408,7 +408,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja - name: create a new user vyos.vyos.vyos_user: diff --git a/docs/vyos.vyos.vyos_vlan_module.rst b/docs/vyos.vyos.vyos_vlan_module.rst index b6e3ccf5..d00260ec 100644 --- a/docs/vyos.vyos.vyos_vlan_module.rst +++ b/docs/vyos.vyos.vyos_vlan_module.rst @@ -434,7 +434,7 @@ Notes Examples -------- -.. code-block:: yaml +.. code-block:: yaml+jinja - name: Create vlan vyos.vyos.vyos_vlan: diff --git a/galaxy.yml b/galaxy.yml index 34146e96..09808f90 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -2,7 +2,7 @@ authors: - Ansible Network Community (ansible-network) dependencies: - "ansible.netcommon": "*" + "ansible.netcommon": "2.0.0" license_file: LICENSE name: vyos description: Ansible Network Collection for VYOS devices. -- cgit v1.2.3