diff options
author | Sandra McCann <samccann@redhat.com> | 2020-05-04 11:48:05 -0400 |
---|---|---|
committer | Sandra McCann <samccann@redhat.com> | 2020-05-04 11:48:05 -0400 |
commit | 07bf155e8c1fabf7b670f0274e8afa4b893aeb00 (patch) | |
tree | 1a8a21472a736d0ad9eb947a086b07abc890057b | |
parent | 0bc2ff1965c2b958b71d6dc144405682a5d78e5b (diff) | |
download | vyos.vyos-07bf155e8c1fabf7b670f0274e8afa4b893aeb00.tar.gz vyos.vyos-07bf155e8c1fabf7b670f0274e8afa4b893aeb00.zip |
clarified collection keyword use
-rw-r--r-- | README.md | 59 |
1 files changed, 31 insertions, 28 deletions
@@ -36,7 +36,36 @@ This collection includes [network resource modules](https://docs.ansible.com/ans ### Using modules from the VyOS collection in your playbooks -You can either call modules by their Fully Qualified Collection Namespace (FQCN), like `vyos.vyos.vyos_l3_interfaces`, or you can call modules by their short name if you list the `vyos.vyos` collection in the playbook's `collections`, as follows: +You can call modules by their Fully Qualified Collection Namespace (FQCN), such as `vyos.vyos.vyos_static_routes`. +The following example task replaces configuration changes in the existing configuration on a VyOS network device, using the FQCN: + +```yaml +--- + - name: Replace device configurations of listed static routes with provided + configurations + register: result + vyos.vyos.vyos_static_routes: &id001 + config: + + - address_families: + + - afi: ipv4 + routes: + + - dest: 192.0.2.32/28 + blackhole_config: + distance: 2 + next_hops: + + - forward_router_address: 192.0.2.7 + + - forward_router_address: 192.0.2.8 + + - forward_router_address: 192.0.2.9 + state: replaced +``` + +Alternately, you can call modules by their short name if you list the `vyos.vyos` collection in the playbook's `collections`, as follows: ```yaml --- @@ -50,7 +79,7 @@ You can either call modules by their Fully Qualified Collection Namespace (FQCN) tasks: - name: Merge the provided configuration with the existing running configuration register: result - vyos.vyos.vyos_l3_interfaces: &id001 + vyos_l3_interfaces: &id001 config: - name: eth1 @@ -78,33 +107,7 @@ You can either call modules by their Fully Qualified Collection Namespace (FQCN) ``` - The following example task replaces configuration changes in the existing configuration on a VyOS network device, using the FQCN: - - ```yaml - --- - - name: Replace device configurations of listed static routes with provided - configurations - register: result - vyos.vyos.vyos_static_routes: &id001 - config: - - - address_families: - - - afi: ipv4 - routes: - - dest: 192.0.2.32/28 - blackhole_config: - distance: 2 - next_hops: - - - forward_router_address: 192.0.2.7 - - - forward_router_address: 192.0.2.8 - - - forward_router_address: 192.0.2.9 - state: replaced -``` |