From 12093546b03413a5f4307698038e4c808f5bab7e Mon Sep 17 00:00:00 2001 From: Allen Robel Date: Tue, 26 Apr 2022 14:57:54 -1000 Subject: [PATCH] Fix documentation for vrf_name and add more detail --- roles/ndfc_common/README.md | 4 ++-- roles/ndfc_vrf_replaced/README.md | 22 ++++++++++++++++++++-- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/roles/ndfc_common/README.md b/roles/ndfc_common/README.md index 4a1b3a2..e2f9c12 100644 --- a/roles/ndfc_common/README.md +++ b/roles/ndfc_common/README.md @@ -193,8 +193,8 @@ This follows the same property names and (more or less) the general structure as Variable | Example | Type | Description -----------------------|----------------|--------------|------------------- -fabric | f1 | str() | Fabric in which network resides -vrf_name | vrf_1 | str() | vrf in which network resides +fabric | f1 | str() | Fabric in which vrf resides +vrf_name | vrf_1 | str() | name of the vrf vrf_id | 9003031 | int() | vrf Layer3 VNI / vn-segment vlan_id | 3031 | int() | vrf associated vlan vrf_template | TemplateVrf | str() | Overlay VRF Template For Leafs diff --git a/roles/ndfc_vrf_replaced/README.md b/roles/ndfc_vrf_replaced/README.md index 112c4e5..acfbea4 100644 --- a/roles/ndfc_vrf_replaced/README.md +++ b/roles/ndfc_vrf_replaced/README.md @@ -17,8 +17,8 @@ Specifically, vrfs are defined in the ``vrfs`` list in the above file. User-def Variable | Example | Type | Description -----------------------|----------------|--------------|------------------- -fabric | f1 | str() | Fabric in which network resides -vrf_name | vrf_1 | str() | vrf in which network resides +fabric | f1 | str() | Fabric in which vrf resides +vrf_name | vrf_1 | str() | name of the vrf vrf_id | 9003031 | int() | vrf Layer3 VNI / vn-segment vlan_id | 3031 | int() | vrf associated vlan vrf_template | TemplateVrf | str() | Overlay VRF Template For Leafs @@ -27,6 +27,24 @@ service_vrf_template | ServiceVrf | str() | Service vrf template attach | See example | list of dict | List of mgmt0 ip addresses of switches on which the VRF is configured attach.ip_address | 192.168.1.1 | IP address | mgmt0 address of the switch to which the vrf is attached +Example entry in vrfs list: + +```yaml +vrfs: +- fabric: "{{ fabrics[0].name }}" + vrf_name: v1 + vrf_id: 9003031 + vlan_id: 3031 + vrf_template: Default_VRF_Universal + vrf_extension_template: Default_VRF_Extension_Universal + service_vrf_template: null + attach: + - ip_address: "{{ leafs[0].ip }}" + - ip_address: "{{ leafs[1].ip }}" + - ip_address: "{{ leafs[2].ip }}" + - ip_address: "{{ leafs[3].ip }}" +``` + See the following for details: [./roles/ndfc_common/README.md](https://github.com/allenrobel/ndfc-roles/tree/master/roles/ndfc_common/README.md)