From 8689285752902b6691a58005655565107f172798 Mon Sep 17 00:00:00 2001 From: svrnm Date: Thu, 11 Jul 2024 10:17:08 +0200 Subject: [PATCH 1/5] Add files from oss-template Signed-off-by: svrnm --- .github/ISSUE_TEMPLATE/BUG_REPORT.md | 36 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md | 25 ++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 27 +++++++++++++++++ .github/dependabot.yml | 11 +++++++ .github/workflows/lint.yml | 24 +++++++++++++++ .github/workflows/scorecard.yml | 29 ++++++++++++++++++ .github/workflows/stale.yml | 25 ++++++++++++++++ .markdownlint.json | 16 ++++++++++ README.md | 4 +-- 9 files changed, 195 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.md create mode 100644 .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/lint.yml create mode 100644 .github/workflows/scorecard.yml create mode 100644 .github/workflows/stale.yml create mode 100644 .markdownlint.json diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md new file mode 100644 index 0000000..8eaadea --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -0,0 +1,36 @@ +--- +name: Bug Report +about: Report a bug to help us improve +title: '' +labels: '' +assignees: '' + +--- + +## Description + +Please provide a description of the problem. + +## Expected Behavior + +Please describe what you expected would happen. + +## Actual Behavior + +Please describe what happened instead. + +## Affected Version + +Please provide the version number where this issue was encountered. + +## Steps to Reproduce + +1. First step +1. Second step +1. etc. + +## Checklist + + +- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md) +- [ ] I have verified this does not duplicate an existing issue diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md new file mode 100644 index 0000000..2af6aba --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md @@ -0,0 +1,25 @@ +--- +name: Feature Request +about: Suggest a feature for this project +title: '' +labels: '' +assignees: '' + +--- + +## Problem Statement + +Please describe the problem to be addressed by the proposed feature. + +## Proposed Solution + +Please describe what you envision the solution to this problem would look like. + +## Alternatives Considered + +Please briefly describe which alternatives, if any, have been considered, including merits of alternate approaches and +tradeoffs being made. + +## Additional Context + +Please provide any other information that may be relevant. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..d9670b4 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,27 @@ +## Description + +Please provide a meaningful description of what this change will do, or is for. Bonus points for including links to +related issues, other PRs, or technical references. + +Note that by _not_ including a description, you are asking reviewers to do extra work to understand the context of this +change, which may lead to your PR taking much longer to review, or result in it not being reviewed at all. + +## Type of Change + +- [ ] Bug Fix +- [ ] New Feature +- [ ] Breaking Change +- [ ] Refactor +- [ ] Documentation +- [ ] Other (please describe) + +## Checklist + + +- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md) +- [ ] Existing issues have been referenced (where applicable) +- [ ] I have verified this change is not present in other open pull requests +- [ ] Functionality is documented +- [ ] All code style checks pass +- [ ] New code contribution is covered by automated tests +- [ ] All new and existing tests pass diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..8d85f88 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,11 @@ +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + groups: + github: + patterns: + - "actions/*" + - "github/*" + schedule: + interval: "weekly" diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..d5f5baf --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,24 @@ +name: lint + +on: + push: + branches: + # Run on pushes to default branch + - main + # Run against pull requests + pull_request: + +jobs: + markdown: + runs-on: ubuntu-latest + steps: + - name: 🔒 harden runner + uses: step-security/harden-runner@17d0e2bd7d51742c71671bd19fa12bdc9d40a3d6 # v2.8.1 + with: + egress-policy: audit + - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 + - name: ⬇️ lint markdown files + uses: avto-dev/markdown-lint@04d43ee9191307b50935a753da3b775ab695eceb # v1.5.0 + with: + config: ".markdownlint.json" + args: "**/*.md .github/**/*.md" diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml new file mode 100644 index 0000000..532cc5c --- /dev/null +++ b/.github/workflows/scorecard.yml @@ -0,0 +1,29 @@ +name: scorecard + +on: + push: + branches: + # Run on pushes to default branch + - main + schedule: + # Run weekly on Saturdays + - cron: "30 1 * * 6" + # Run when branch protection rules change + branch_protection_rule: + # Run the workflow manually + workflow_dispatch: + +# Declare default permissions as read-only +permissions: read-all + +jobs: + run-scorecard: + # Call reusable workflow file + uses: cisco-ospo/.github/.github/workflows/_scorecard.yml@main + permissions: + id-token: write + security-events: write + secrets: inherit + with: + # Publish results of Scorecard analysis + publish-results: true diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml new file mode 100644 index 0000000..152ddf8 --- /dev/null +++ b/.github/workflows/stale.yml @@ -0,0 +1,25 @@ +name: stale + +on: + schedule: + # Run weekly on Saturdays + - cron: "30 1 * * 6" + # Run the workflow manually + workflow_dispatch: + +# Declare default permissions as read-only +permissions: read-all + +jobs: + mark-stale: + # Call reusable workflow file + uses: cisco-ospo/.github/.github/workflows/_stale.yml@main + permissions: + contents: read + issues: write + pull-requests: write + with: + days-until-stale: 60 + days-until-close: 7 + stale-label: "stale" + exempt-label: "keep" diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..2a820e7 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,16 @@ +{ + "default": true, + "MD013": { + "line_length": 10000, + "headings": false, + "code_blocks": false, + "tables": false + }, + "MD024": { + "siblings_only": true + }, + "MD025": { + "front_matter_title": "" + }, + "MD041": false +} diff --git a/README.md b/README.md index 5b0f1b5..39874dc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# ndfc-roles +Automating NDFC using Ansible -Automating NDFC using Ansible +# ndfc-roles ## Getting started From 2644260fb211585ac39619235527a2b217e996b4 Mon Sep 17 00:00:00 2001 From: svrnm Date: Thu, 11 Jul 2024 10:20:40 +0200 Subject: [PATCH 2/5] undo readme changes Signed-off-by: svrnm --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 39874dc..5b0f1b5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -Automating NDFC using Ansible - # ndfc-roles +Automating NDFC using Ansible + ## Getting started This repo contains Ansible Roles and example playbooks that, together, implement a basic Spine/Leaf VXLAN/EVPN fabric using Cisco's DCNM/NDFC Controller. From 9fdf100ed64730c421acd86ad25e5030b8e6425a Mon Sep 17 00:00:00 2001 From: Allen Robel Date: Fri, 12 Jul 2024 07:00:33 -1000 Subject: [PATCH 3/5] Fix markdown levels Most of the README.md files in the roles directory contained skips from level 1 (#) to level 3 (###). Fixed these. --- roles/ndfc_device_config_get/README.md | 8 +- roles/ndfc_device_deleted/README.md | 8 +- roles/ndfc_device_deleted_all/README.md | 8 +- .../README.md | 8 +- .../README.md | 8 +- roles/ndfc_device_info_get/README.md | 256 +++++++++--------- .../README.md | 8 +- .../README.md | 8 +- .../README.md | 8 +- roles/ndfc_device_list_get/README.md | 12 +- roles/ndfc_device_list_merged/README.md | 10 +- roles/ndfc_device_merged/README.md | 10 +- roles/ndfc_device_merged_all/README.md | 10 +- roles/ndfc_device_model_number_get/README.md | 8 +- roles/ndfc_device_names_get/README.md | 8 +- roles/ndfc_device_serial_number_get/README.md | 8 +- roles/ndfc_fabric_config_get/README.md | 8 +- roles/ndfc_network_config_get/README.md | 8 +- roles/ndfc_network_deleted/README.md | 12 +- roles/ndfc_network_deleted_all/README.md | 10 +- roles/ndfc_network_info_get/README.md | 12 +- roles/ndfc_network_replaced/README.md | 8 +- roles/ndfc_network_replaced_all/README.md | 8 +- .../ndfc_policy_vrf_rt_import_evpn/README.md | 8 +- .../README.md | 8 +- roles/ndfc_rest_config_deploy/README.md | 8 +- roles/ndfc_rest_config_deploy_all/README.md | 8 +- .../README.md | 8 +- .../ndfc_rest_device_list_by_fabric/README.md | 8 +- roles/ndfc_rest_device_rediscover/README.md | 12 +- roles/ndfc_rest_device_set_role/README.md | 10 +- .../README.md | 8 +- .../README.md | 6 +- .../README.md | 8 +- roles/ndfc_rest_fabric_asn_get/README.md | 10 +- .../README.md | 8 +- .../README.md | 8 +- .../README.md | 8 +- .../README.md | 8 +- roles/ndfc_rest_fabric_create_msd/README.md | 8 +- roles/ndfc_rest_fabric_delete/README.md | 8 +- roles/ndfc_rest_fabric_info_get/README.md | 10 +- .../ndfc_rest_fabric_msd_child_add/README.md | 8 +- .../README.md | 8 +- .../ndfc_rest_interface_no_shutdown/README.md | 10 +- roles/ndfc_rest_interface_shutdown/README.md | 10 +- roles/ndfc_rest_service_node_add/README.md | 10 +- roles/ndfc_rest_vpc_create/README.md | 8 +- roles/ndfc_rest_vpc_delete/README.md | 8 +- roles/ndfc_rest_vrf_list_by_fabric/README.md | 8 +- roles/ndfc_service_node_config_get/README.md | 8 +- roles/ndfc_service_node_deleted/README.md | 8 +- roles/ndfc_service_node_merged/README.md | 8 +- .../README.md | 8 +- .../README.md | 8 +- roles/ndfc_vpc_config_get/README.md | 8 +- roles/ndfc_vpc_interface_merged_all/README.md | 8 +- roles/ndfc_vrf_all/README.md | 14 +- roles/ndfc_vrf_config_get/README.md | 13 +- roles/ndfc_vrf_query/README.md | 10 +- roles/ndfc_vrf_replaced/README.md | 10 +- 61 files changed, 397 insertions(+), 388 deletions(-) diff --git a/roles/ndfc_device_config_get/README.md b/roles/ndfc_device_config_get/README.md index a1bc7d6..99166f5 100644 --- a/roles/ndfc_device_config_get/README.md +++ b/roles/ndfc_device_config_get/README.md @@ -2,7 +2,7 @@ Retrieve local configuration for ``device_name`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -17,7 +17,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -34,12 +34,12 @@ See the following for details: var: device_config ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_device_deleted/README.md b/roles/ndfc_device_deleted/README.md index b74c3cd..91cf462 100644 --- a/roles/ndfc_device_deleted/README.md +++ b/roles/ndfc_device_deleted/README.md @@ -2,7 +2,7 @@ Delete device ``device_name`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -17,7 +17,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -29,12 +29,12 @@ See the following for details: device_name: spine_1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_device_deleted_all/README.md b/roles/ndfc_device_deleted_all/README.md index b10bf7c..52dc9e3 100644 --- a/roles/ndfc_device_deleted_all/README.md +++ b/roles/ndfc_device_deleted_all/README.md @@ -2,7 +2,7 @@ Delete all devices from fabric ``fabric_name`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -17,7 +17,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -29,12 +29,12 @@ See the following for details: fabric_name: f1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_device_generated_configs_all_get/README.md b/roles/ndfc_device_generated_configs_all_get/README.md index 9936413..bad5c9e 100644 --- a/roles/ndfc_device_generated_configs_all_get/README.md +++ b/roles/ndfc_device_generated_configs_all_get/README.md @@ -2,7 +2,7 @@ Query populated generated_config from all devices in fabric ``fabric_name`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -18,7 +18,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -30,12 +30,12 @@ See the following for details: fabric_name: f1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_device_generated_configs_get/README.md b/roles/ndfc_device_generated_configs_get/README.md index 370d10f..6379ecf 100644 --- a/roles/ndfc_device_generated_configs_get/README.md +++ b/roles/ndfc_device_generated_configs_get/README.md @@ -4,7 +4,7 @@ Retrieve populated generated configs from ``device_name`` in fabric ``fabric_nam Store in variable ``device_generated_configs`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -20,7 +20,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -37,12 +37,12 @@ See the following for details: when: "device_generated_configs != ''" ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_device_info_get/README.md b/roles/ndfc_device_info_get/README.md index 18ffe64..30c2e38 100644 --- a/roles/ndfc_device_info_get/README.md +++ b/roles/ndfc_device_info_get/README.md @@ -4,7 +4,7 @@ Query device ``device_name`` on the NDFC controller A ``device_info`` dictionary is returned, as described below. -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -19,7 +19,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml # Query NX-OS switch associated with fabric_name + device_name @@ -45,140 +45,142 @@ See the following for details: msg: "switchDbId: {{ device_info.switchDbID }}" ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) -### Example returned object device_info (as of NDFC version 12.0.1) +## Example returned object device_info + +As of NDFC version 12.0.1 ```json -{ - "device_info": { - "activeSupSlot": 0, - "availPorts": 0, - "colDBId": 0, - "connUnitStatus": 0, - "consistencyState": true, - "contact": "", - "cpuUsage": 25, - "deviceType": "Switch_Fabric", - "displayHdrs": [ - "Name", - "IP Address", - "Fabric", - "WWN", - "FC Ports", - "Vendor", - "Model", - "Release", - "UpTime" - ], - "displayValues": [ - "cvd_leaf_2311", - "172.XX.XX.XX", - "fabric_2", - "FDOXXXXXXXX", - "54", - "Cisco", - "N9K-C93180YC-EX", - "10.2(3)", - "18 days, 23:02:23" - ], - "domain": null, - "domainID": 0, - "elementType": null, - "fabricId": 3, - "fabricName": "fabric_2", - "fabricTechnology": "VXLANFabric", - "fcoeEnabled": false, - "fex": false, - "fexMap": {}, - "fid": 3, - "health": -1, - "hostName": "cvd_leaf_2311", - "index": 3, - "interfaces": null, - "ipAddress": "172.XX.XX.XX", - "ipDomain": "", - "isEchSupport": false, - "isLan": false, - "isNonNexus": false, - "isPmCollect": false, - "isTrapDelayed": false, - "isVpcConfigured": true, - "is_smlic_enabled": false, - "keepAliveState": "Peer is not alive", - "lastScanTime": 1649700732019, - "licenseDetail": null, - "licenseViolation": false, - "linkName": null, - "location": "", - "logicalName": "cvd_leaf_2311", - "managable": true, - "mds": false, - "membership": null, - "memoryUsage": 35, - "mgmtAddress": null, - "mode": "Normal", - "model": "N9K-C93180YC-EX", - "modelType": 0, - "moduleIndexOffset": 9999, - "modules": null, - "name": null, - "network": "LAN", - "nonMdsModel": "N9K-C93180YC-EX", - "npvEnabled": false, - "numberOfPorts": 54, - "peer": "cvd_leaf_2312", - "peerSerialNumber": "FDOXXXXXXXX", - "peerSwitchDbId": 576650, - "peerlinkState": "Peer link is down", - "ports": 0, - "present": true, - "primaryIP": null, - "primarySwitchDbID": 0, - "principal": null, - "recvIntf": "mgmt0", - "release": "10.2(3)", - "role": "None established", - "sanAnalyticsCapable": false, - "scope": null, - "secondaryIP": "", - "secondarySwitchDbID": 0, - "sendIntf": "mgmt0", - "serialNumber": "FDOXXXXXXXX", - "standbySupState": 0, - "status": "ok", - "swWwn": null, - "swWwnName": "FDOXXXXXXXX", - "switchDbID": 575610, - "switchRole": "leaf", - "switchRoleEnum": "Leaf", - "sysDescr": "", - "systemMode": null, - "uid": 0, - "unmanagableCause": "", - "upTime": 163814317, - "upTimeNumber": 0, - "upTimeStr": "18 days, 23:02:23", - "usedPorts": 0, - "username": null, - "vdcId": -1, - "vdcMac": null, - "vdcName": "", - "vendor": "Cisco", - "version": null, - "vpcDomain": 1, - "vrf": "management", - "vsanWwn": null, - "vsanWwnName": null, - "wwn": null + { + "device_info": { + "activeSupSlot": 0, + "availPorts": 0, + "colDBId": 0, + "connUnitStatus": 0, + "consistencyState": true, + "contact": "", + "cpuUsage": 25, + "deviceType": "Switch_Fabric", + "displayHdrs": [ + "Name", + "IP Address", + "Fabric", + "WWN", + "FC Ports", + "Vendor", + "Model", + "Release", + "UpTime" + ], + "displayValues": [ + "cvd_leaf_2311", + "172.XX.XX.XX", + "fabric_2", + "FDOXXXXXXXX", + "54", + "Cisco", + "N9K-C93180YC-EX", + "10.2(3)", + "18 days, 23:02:23" + ], + "domain": null, + "domainID": 0, + "elementType": null, + "fabricId": 3, + "fabricName": "fabric_2", + "fabricTechnology": "VXLANFabric", + "fcoeEnabled": false, + "fex": false, + "fexMap": {}, + "fid": 3, + "health": -1, + "hostName": "cvd_leaf_2311", + "index": 3, + "interfaces": null, + "ipAddress": "172.XX.XX.XX", + "ipDomain": "", + "isEchSupport": false, + "isLan": false, + "isNonNexus": false, + "isPmCollect": false, + "isTrapDelayed": false, + "isVpcConfigured": true, + "is_smlic_enabled": false, + "keepAliveState": "Peer is not alive", + "lastScanTime": 1649700732019, + "licenseDetail": null, + "licenseViolation": false, + "linkName": null, + "location": "", + "logicalName": "cvd_leaf_2311", + "managable": true, + "mds": false, + "membership": null, + "memoryUsage": 35, + "mgmtAddress": null, + "mode": "Normal", + "model": "N9K-C93180YC-EX", + "modelType": 0, + "moduleIndexOffset": 9999, + "modules": null, + "name": null, + "network": "LAN", + "nonMdsModel": "N9K-C93180YC-EX", + "npvEnabled": false, + "numberOfPorts": 54, + "peer": "cvd_leaf_2312", + "peerSerialNumber": "FDOXXXXXXXX", + "peerSwitchDbId": 576650, + "peerlinkState": "Peer link is down", + "ports": 0, + "present": true, + "primaryIP": null, + "primarySwitchDbID": 0, + "principal": null, + "recvIntf": "mgmt0", + "release": "10.2(3)", + "role": "None established", + "sanAnalyticsCapable": false, + "scope": null, + "secondaryIP": "", + "secondarySwitchDbID": 0, + "sendIntf": "mgmt0", + "serialNumber": "FDOXXXXXXXX", + "standbySupState": 0, + "status": "ok", + "swWwn": null, + "swWwnName": "FDOXXXXXXXX", + "switchDbID": 575610, + "switchRole": "leaf", + "switchRoleEnum": "Leaf", + "sysDescr": "", + "systemMode": null, + "uid": 0, + "unmanagableCause": "", + "upTime": 163814317, + "upTimeNumber": 0, + "upTimeStr": "18 days, 23:02:23", + "usedPorts": 0, + "username": null, + "vdcId": -1, + "vdcMac": null, + "vdcName": "", + "vendor": "Cisco", + "version": null, + "vpcDomain": 1, + "vrf": "management", + "vsanWwn": null, + "vsanWwnName": null, + "wwn": null + } } -} ``` \ No newline at end of file diff --git a/roles/ndfc_device_interface_config_all_get/README.md b/roles/ndfc_device_interface_config_all_get/README.md index 8fa0db6..403091a 100644 --- a/roles/ndfc_device_interface_config_all_get/README.md +++ b/roles/ndfc_device_interface_config_all_get/README.md @@ -2,7 +2,7 @@ Query the config for a specific interface across all devices in fabric ``fabric_name`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -19,7 +19,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -32,12 +32,12 @@ See the following for details: interface_name: Ethernet1/11 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_device_ipv4_address_local_get/README.md b/roles/ndfc_device_ipv4_address_local_get/README.md index de547d2..e1775f0 100644 --- a/roles/ndfc_device_ipv4_address_local_get/README.md +++ b/roles/ndfc_device_ipv4_address_local_get/README.md @@ -10,7 +10,7 @@ Since this operation is local, the result is returned faster than ``ndfc_device_ SEE ALSO: ``ndfc_device_ipv4_address_remote_get`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -25,7 +25,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml # Query ./inventory/group_vars/ndfc/02_devices.yml for fabric_name + device_name @@ -44,12 +44,12 @@ See the following for details: when: "device_ipv4_address != ''" ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) \ No newline at end of file diff --git a/roles/ndfc_device_ipv4_address_remote_get/README.md b/roles/ndfc_device_ipv4_address_remote_get/README.md index 066ea37..631fc26 100644 --- a/roles/ndfc_device_ipv4_address_remote_get/README.md +++ b/roles/ndfc_device_ipv4_address_remote_get/README.md @@ -10,7 +10,7 @@ Since this operation involves a query of the NDFC controller, the result is retu SEE ALSO: ``ndfc_device_ipv4_address_local_get`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -25,7 +25,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml # Query NX-OS switch associated with fabric_name + device_name @@ -44,12 +44,12 @@ See the following for details: when: "device_ipv4_address != ''" ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) \ No newline at end of file diff --git a/roles/ndfc_device_list_get/README.md b/roles/ndfc_device_list_get/README.md index f856ca3..ce27ca6 100644 --- a/roles/ndfc_device_list_get/README.md +++ b/roles/ndfc_device_list_get/README.md @@ -2,11 +2,11 @@ Retrieve device configuration from the local inventory for all devices in fabric ``fabric_name`` -### Returns +## Returns A JSON list of objects containing device configurations, including seed_ip, role, password, username. -#### Example structure of returned information: +### Example structure of returned information: ```json [ @@ -25,7 +25,7 @@ A JSON list of objects containing device configurations, including seed_ip, role ] ``` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -39,7 +39,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -56,12 +56,12 @@ See the following for details: when: "device_list != ''" ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_device_list_merged/README.md b/roles/ndfc_device_list_merged/README.md index 67b366c..99fcef6 100644 --- a/roles/ndfc_device_list_merged/README.md +++ b/roles/ndfc_device_list_merged/README.md @@ -2,7 +2,7 @@ Merge a list of devices into a fabric. -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -36,9 +36,9 @@ Variable | Type | Description device_password | string | The password used to login to the device device_username | string | The username used to login to the device -### Dependencies +## Dependencies -### Example Playbooks +## Example Playbooks Merge all devices in the local inventory for ``fabric_name`` f1 into the topology. @@ -59,12 +59,12 @@ Merge all devices in the local inventory for ``fabric_name`` f1 into the topolog devices: "{{ device_list }}" ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_device_merged/README.md b/roles/ndfc_device_merged/README.md index 3ef43c8..7f003d3 100644 --- a/roles/ndfc_device_merged/README.md +++ b/roles/ndfc_device_merged/README.md @@ -2,7 +2,7 @@ Merge device ``device_name`` into the topology. -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -36,9 +36,9 @@ Variable | Type | Description device_password | string | The password used to login to the device device_username | string | The username used to login to the device -### Dependencies +## Dependencies -### Example Playbooks +## Example Playbooks ```yaml --- @@ -50,12 +50,12 @@ device_username | string | The username used to login to the device device_name: spine_1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_device_merged_all/README.md b/roles/ndfc_device_merged_all/README.md index 1f16529..59fc7ff 100644 --- a/roles/ndfc_device_merged_all/README.md +++ b/roles/ndfc_device_merged_all/README.md @@ -2,7 +2,7 @@ Merge all leaf, spine, border_gateway devices into fabric ``fabric_name``. -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -34,9 +34,9 @@ Variable | Type | Description device_password | string | The password used to login to the device device_username | string | The username used to login to the device -### Dependencies +## Dependencies -### Example Playbook +## Example Playbook ```yaml --- @@ -48,12 +48,12 @@ device_username | string | The username used to login to the device fabric_name: f1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_device_model_number_get/README.md b/roles/ndfc_device_model_number_get/README.md index a400af1..a2cbc2d 100644 --- a/roles/ndfc_device_model_number_get/README.md +++ b/roles/ndfc_device_model_number_get/README.md @@ -4,7 +4,7 @@ Retrieve ``device_model_number`` from NDFC controller, given ``device_name``. The device's model number is returned in variable ``device_model_number``. -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -19,7 +19,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml # Query NX-OS switch associated with fabric_name + device_name @@ -38,12 +38,12 @@ See the following for details: when: "device_model_number != ''" ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_device_names_get/README.md b/roles/ndfc_device_names_get/README.md index ccf00c4..4fe9869 100644 --- a/roles/ndfc_device_names_get/README.md +++ b/roles/ndfc_device_names_get/README.md @@ -2,7 +2,7 @@ Use ``set_fact`` to set a list (``device_names``) of device names matching devices in fabric ``fabric_name`` with role ``role``. -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -19,7 +19,7 @@ See the following for details: [./inventory/group_vars/README.md](https://github.com/allenrobel/ndfc-roles/tree/master/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -37,12 +37,12 @@ See the following for details: when: "device_names != ''" ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_device_serial_number_get/README.md b/roles/ndfc_device_serial_number_get/README.md index 9fe2c9f..c9b15e5 100644 --- a/roles/ndfc_device_serial_number_get/README.md +++ b/roles/ndfc_device_serial_number_get/README.md @@ -4,7 +4,7 @@ Return ``device_serial_number`` given ``device_name``. The device's serial number is returned in variable ``device_serial_number``. -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -18,7 +18,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml # Query NX-OS switch associated with fabric_name + device_name @@ -37,12 +37,12 @@ See the following for details: when: "device_serial_number != ''" ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_fabric_config_get/README.md b/roles/ndfc_fabric_config_get/README.md index 99ed7b2..0a00e56 100644 --- a/roles/ndfc_fabric_config_get/README.md +++ b/roles/ndfc_fabric_config_get/README.md @@ -7,7 +7,7 @@ Retrieve config for ``fabric_name`` from the following sections of ``./inventory - switch_fabrics - external_fabrics -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -21,7 +21,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -33,12 +33,12 @@ See the following for details: fabric_name: f1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_network_config_get/README.md b/roles/ndfc_network_config_get/README.md index 9d9a9ee..db63c97 100644 --- a/roles/ndfc_network_config_get/README.md +++ b/roles/ndfc_network_config_get/README.md @@ -2,7 +2,7 @@ Retrieve local configuration for ``network_name`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -16,7 +16,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -33,12 +33,12 @@ See the following for details: var: network_config ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_network_deleted/README.md b/roles/ndfc_network_deleted/README.md index c4ea8e9..b71828c 100644 --- a/roles/ndfc_network_deleted/README.md +++ b/roles/ndfc_network_deleted/README.md @@ -2,7 +2,7 @@ Delete network ``network_name`` where ``network_name`` matches the ``name`` key in the local ``networks`` dictionary in [./inventory/group_vars/ndfc/03_networks.yml](/inventory/group_vars/ndfc/03_networks.yml) -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -16,9 +16,9 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbooks +## Example Playbooks -# Delete network_name f1_n1111 +### Delete network_name f1_n1111 ```yaml --- @@ -30,7 +30,7 @@ See the following for details: network_name: f1_n1111 ``` -# Delete network_name msd_n1111, which resides in fabric MSD (an msd fabric) +### Delete network_name msd_n1111, which resides in fabric MSD (an msd fabric) This will delete network_name msd_n1111 from all child fabrics of fabric MSD. @@ -44,10 +44,10 @@ This will delete network_name msd_n1111 from all child fabrics of fabric MSD. network_name: msd_n1111 ``` -### License +## License BSD -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_network_deleted_all/README.md b/roles/ndfc_network_deleted_all/README.md index 48ab995..86d2ec6 100644 --- a/roles/ndfc_network_deleted_all/README.md +++ b/roles/ndfc_network_deleted_all/README.md @@ -4,7 +4,7 @@ Delete all networks in fabric ``fabric_name`` NOTE: If the networks were created in an MSD fabric, Ansible will throw an InvalidFabric error if you set ``fabric_name`` to that of a child/switch fabric. -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -18,9 +18,9 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbooks +## Example Playbooks -# Delete all networks in external fabric_name f1 +### Delete all networks in external fabric_name f1 ```yaml --- @@ -32,12 +32,12 @@ See the following for details: fabric_name: MSD ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_network_info_get/README.md b/roles/ndfc_network_info_get/README.md index 4d71f2e..cf1f18a 100644 --- a/roles/ndfc_network_info_get/README.md +++ b/roles/ndfc_network_info_get/README.md @@ -2,7 +2,7 @@ Query the NDFC controller and retrieve ``network_info`` dictionary given ``network_name`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -24,7 +24,7 @@ Variable | Type | Description ----------------|------|---------------------------------------- network_info | dict | information pertaining to network ``network_name`` -### Example Playbooks +## Example Playbooks Retrieve ``network_info`` dictionary for ``network_name`` msd_n1111 @@ -42,10 +42,12 @@ Retrieve ``network_info`` dictionary for ``network_name`` msd_n1111 msg: "network_info: {{ network_info | default('unable to find network. Check network_name.', true) }}" ``` -### License +## Licensing -BSD +GNU General Public License v3.0 or later. -### Author Information +See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. + +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_network_replaced/README.md b/roles/ndfc_network_replaced/README.md index 03b1ad4..335eea5 100644 --- a/roles/ndfc_network_replaced/README.md +++ b/roles/ndfc_network_replaced/README.md @@ -2,7 +2,7 @@ Replace network ``network_name`` with its current local definition in [./inventory/group_vars/ndfc/03_networks.yml](/inventory/group_vars/ndfc/03_networks.yml) -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -17,7 +17,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -29,12 +29,12 @@ See the following for details: network_name: f1_n1111 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_network_replaced_all/README.md b/roles/ndfc_network_replaced_all/README.md index 0947a6d..29ea994 100644 --- a/roles/ndfc_network_replaced_all/README.md +++ b/roles/ndfc_network_replaced_all/README.md @@ -2,7 +2,7 @@ Replace all networks in fabric ``fabric_name`` with their current definitions in Replace all networks in fabric ``fabric_name`` with their current definitions in ``./roles/ndfc_common/vars/main.yml`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -17,7 +17,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -29,12 +29,12 @@ See the following for details: fabric_name: MSD ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_policy_vrf_rt_import_evpn/README.md b/roles/ndfc_policy_vrf_rt_import_evpn/README.md index 951d0fb..3bbf36f 100644 --- a/roles/ndfc_policy_vrf_rt_import_evpn/README.md +++ b/roles/ndfc_policy_vrf_rt_import_evpn/README.md @@ -6,7 +6,7 @@ NOTE: This role isn't needed when route-target imports are added to a VRF's conf - [./inventory/group_vars/README.md](/inventory/group_vars/README.md) - [./inventory/group_vars/ndfc/04_vrfs.yml](/inventory/group_vars/ndfc/04_vrfs.yml) -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -26,7 +26,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml # Import vrf v2's route-targets into vrf v1 on device leaf_2 in fabric f1, using Ansible state 'merged' @@ -43,12 +43,12 @@ See the following for details: state: merged ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_policy_vrf_rt_import_evpn_loop/README.md b/roles/ndfc_policy_vrf_rt_import_evpn_loop/README.md index 650519c..232ac52 100644 --- a/roles/ndfc_policy_vrf_rt_import_evpn_loop/README.md +++ b/roles/ndfc_policy_vrf_rt_import_evpn_loop/README.md @@ -8,7 +8,7 @@ NOTE 2: This role isn't needed when route-target imports are added to a VRF's co - [./inventory/group_vars/README.md](/inventory/group_vars/README.md) - [./inventory/group_vars/ndfc/04_vrfs.yml](/inventory/group_vars/ndfc/04_vrfs.yml) -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -28,7 +28,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook The example below performs a bi-directional import of route-targets between vrfs v1 and v2 on four leaf devices in fabric f1. @@ -85,12 +85,12 @@ The example below performs a bi-directional import of route-targets between vrfs fabric_name: f1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_config_deploy/README.md b/roles/ndfc_rest_config_deploy/README.md index 8a0acef..0ab1396 100644 --- a/roles/ndfc_rest_config_deploy/README.md +++ b/roles/ndfc_rest_config_deploy/README.md @@ -2,7 +2,7 @@ Issue NDFC POST REST API calls to invoke config-save on ``fabric_name`` and config-deploy on fabric ``fabric_name`` device ``device_name``. -### Role Variables +## Role Variables Variable | Type | Description -------------------|---------|------------ @@ -15,7 +15,7 @@ Variable | Type | Description forceShowRun | boolean | default, false inclAllMSDSwitches | boolean | default, false -### Example Playbook +## Example Playbook ```yaml --- @@ -27,12 +27,12 @@ inclAllMSDSwitches | boolean | default, false device_name: leaf_1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_config_deploy_all/README.md b/roles/ndfc_rest_config_deploy_all/README.md index e68b078..1d7b1f9 100644 --- a/roles/ndfc_rest_config_deploy_all/README.md +++ b/roles/ndfc_rest_config_deploy_all/README.md @@ -2,7 +2,7 @@ Issue NDFC POST REST API calls to invoke config-save and config-deploy in fabric ``fabric_name`` -### Role Variables +## Role Variables Variable | Type | Description -------------------|---------|------------ @@ -23,7 +23,7 @@ Variable | Type | Description forceShowRun | boolean | default, false inclAllMSDSwitches | boolean | default, false -### Example Playbook +## Example Playbook ```yaml --- @@ -35,12 +35,12 @@ inclAllMSDSwitches | boolean | default, false fabric_name: f1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_device_intent_config_get/README.md b/roles/ndfc_rest_device_intent_config_get/README.md index f1efe24..2baa284 100644 --- a/roles/ndfc_rest_device_intent_config_get/README.md +++ b/roles/ndfc_rest_device_intent_config_get/README.md @@ -2,7 +2,7 @@ Retrieve intended config for ``device_name`` -### Role Variables +## Role Variables Variable | Type | Description -------------------|---------|------------ @@ -23,7 +23,7 @@ Variable | Type | Description forceShowRun | boolean | default, false inclAllMSDSwitches | boolean | default, false -### Example Playbook +## Example Playbook ```yaml --- @@ -40,12 +40,12 @@ inclAllMSDSwitches | boolean | default, false var: device_intent_config ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_device_list_by_fabric/README.md b/roles/ndfc_rest_device_list_by_fabric/README.md index e1dcb5a..b6ea036 100644 --- a/roles/ndfc_rest_device_list_by_fabric/README.md +++ b/roles/ndfc_rest_device_list_by_fabric/README.md @@ -5,7 +5,7 @@ Retrieve list of devices in fabric ``fabric_name`` Returns JSON object ``switch_list`` which will be a list of switch dictionaries if the GET request succeeded, or an empty list if the GET request failed. -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -20,7 +20,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook The playbook below prints select information for every switch in fabric f2. @@ -42,12 +42,12 @@ The playbook below prints select information for every switch in fabric f2. label: device_info ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_device_rediscover/README.md b/roles/ndfc_rest_device_rediscover/README.md index f13a19c..cfc217c 100644 --- a/roles/ndfc_rest_device_rediscover/README.md +++ b/roles/ndfc_rest_device_rediscover/README.md @@ -2,7 +2,7 @@ Rediscover device ``device_name`` in fabric ``fabric_name`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -19,7 +19,7 @@ See the following for details: [./inventory/group_vars/README.md](https://github.com/allenrobel/ndfc-roles/tree/master/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -32,10 +32,12 @@ See the following for details: device_name: spine_1 ``` -### License +## Licensing -BSD +GNU General Public License v3.0 or later. -### Author Information +See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. + +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_device_set_role/README.md b/roles/ndfc_rest_device_set_role/README.md index b5c54f9..987577f 100644 --- a/roles/ndfc_rest_device_set_role/README.md +++ b/roles/ndfc_rest_device_set_role/README.md @@ -2,7 +2,7 @@ Set role for device ``device_name``. -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -26,9 +26,9 @@ Variable | Type | Description forceShowRun | boolean | Default: ``false`` Included in the config-deploy REST call payload. inclAllMSDSwitches | boolean | Default: ``false`` Included in the config-deploy REST call payload. -### Dependencies +## Dependencies -### Example Playbooks +## Example Playbooks ```yaml --- @@ -42,12 +42,12 @@ inclAllMSDSwitches | boolean | Default: ``false`` Included in the config-deploy role: spine ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_fabric_access_mode_get/README.md b/roles/ndfc_rest_fabric_access_mode_get/README.md index d4b28f5..93486e0 100644 --- a/roles/ndfc_rest_fabric_access_mode_get/README.md +++ b/roles/ndfc_rest_fabric_access_mode_get/README.md @@ -2,7 +2,7 @@ Given ``fabric_name`` return fabric access_mode in var ``read_only`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -16,7 +16,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example playbook +## Example playbook ```yaml --- @@ -32,12 +32,12 @@ See the following for details: msg: "fabric {{ fabric_name }} read_only: {{ read_only }}" ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_fabric_access_mode_set/README.md b/roles/ndfc_rest_fabric_access_mode_set/README.md index 11fb232..c42772b 100644 --- a/roles/ndfc_rest_fabric_access_mode_set/README.md +++ b/roles/ndfc_rest_fabric_access_mode_set/README.md @@ -2,7 +2,7 @@ Given ``fabric_name`` set the fabric access_mode to true or false via var ``read_only`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|---------|---------------------------------------- @@ -17,12 +17,12 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_fabric_active_fabrics_get/README.md b/roles/ndfc_rest_fabric_active_fabrics_get/README.md index c8980cf..2ab0a6b 100644 --- a/roles/ndfc_rest_fabric_active_fabrics_get/README.md +++ b/roles/ndfc_rest_fabric_active_fabrics_get/README.md @@ -2,13 +2,13 @@ Returns the list of active fabrics on the Nexus Dashboard Fabric Controller. -### Returned Variables +## Returned Variables Variable | Type | Description ----------------|--------------|---------------------------------------- active_fabrics | list of dict | a list of active fabrics -### Example Playbook +## Example Playbook ```yaml --- @@ -23,12 +23,12 @@ active_fabrics | list of dict | a list of active fabrics when: "active_fabrics != ''" ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_fabric_asn_get/README.md b/roles/ndfc_rest_fabric_asn_get/README.md index b199f17..60c9df8 100644 --- a/roles/ndfc_rest_fabric_asn_get/README.md +++ b/roles/ndfc_rest_fabric_asn_get/README.md @@ -2,13 +2,13 @@ Given ``fabric_name`` return fabric BGP ASN in var ``fabric_asn`` -### Returned variables +## Returned variables Variable | Type | Description ----------------|--------|---------------------------------------- fabric_asn | string | The BGP AS of the queried fabric -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -22,7 +22,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbooks +## Example Playbooks ```yaml --- @@ -39,12 +39,12 @@ See the following for details: when: "fabric_asn != ''" ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_fabric_create_easy_fabric/README.md b/roles/ndfc_rest_fabric_create_easy_fabric/README.md index 0465d36..1482f69 100644 --- a/roles/ndfc_rest_fabric_create_easy_fabric/README.md +++ b/roles/ndfc_rest_fabric_create_easy_fabric/README.md @@ -2,7 +2,7 @@ Create fabric ``fabric_name`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -16,7 +16,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -28,12 +28,12 @@ See the following for details: fabric_name: f1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_fabric_create_easy_fabric_ebgp/README.md b/roles/ndfc_rest_fabric_create_easy_fabric_ebgp/README.md index f75df49..a22d799 100644 --- a/roles/ndfc_rest_fabric_create_easy_fabric_ebgp/README.md +++ b/roles/ndfc_rest_fabric_create_easy_fabric_ebgp/README.md @@ -2,7 +2,7 @@ Create Easy_Fabric_eBGP fabric ``fabric_name`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -16,7 +16,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -28,12 +28,12 @@ See the following for details: fabric_name: EBGP_1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_fabric_create_external/README.md b/roles/ndfc_rest_fabric_create_external/README.md index 5fabade..3f98b28 100644 --- a/roles/ndfc_rest_fabric_create_external/README.md +++ b/roles/ndfc_rest_fabric_create_external/README.md @@ -2,7 +2,7 @@ Create External_Fabric ``fabric_name`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -16,7 +16,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -28,12 +28,12 @@ See the following for details: fabric_name: ext_fabric_1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_fabric_create_lan_classic/README.md b/roles/ndfc_rest_fabric_create_lan_classic/README.md index 546d6fe..24f5f1a 100644 --- a/roles/ndfc_rest_fabric_create_lan_classic/README.md +++ b/roles/ndfc_rest_fabric_create_lan_classic/README.md @@ -2,7 +2,7 @@ Create LAN_Classic fabric ``fabric_name`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -16,7 +16,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -28,12 +28,12 @@ See the following for details: fabric_name: LC_1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_fabric_create_msd/README.md b/roles/ndfc_rest_fabric_create_msd/README.md index ac2e89d..83f02ac 100644 --- a/roles/ndfc_rest_fabric_create_msd/README.md +++ b/roles/ndfc_rest_fabric_create_msd/README.md @@ -2,7 +2,7 @@ Create Multi-Site Domain (MSD) fabric ``fabric_name`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -16,7 +16,7 @@ See the following for details: [./inventory/group_vars/README.md](https://github.com/allenrobel/ndfc-roles/tree/master/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -28,12 +28,12 @@ See the following for details: fabric_name: MSD ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_fabric_delete/README.md b/roles/ndfc_rest_fabric_delete/README.md index 297a3fd..8796385 100644 --- a/roles/ndfc_rest_fabric_delete/README.md +++ b/roles/ndfc_rest_fabric_delete/README.md @@ -2,7 +2,7 @@ Delete fabric ``fabric_name`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -16,7 +16,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -28,12 +28,12 @@ See the following for details: fabric_name: f1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_fabric_info_get/README.md b/roles/ndfc_rest_fabric_info_get/README.md index a808119..66286ad 100644 --- a/roles/ndfc_rest_fabric_info_get/README.md +++ b/roles/ndfc_rest_fabric_info_get/README.md @@ -2,7 +2,7 @@ Returns information for ``fabric_name`` in variable ``fabric_info`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -16,7 +16,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Default Variables +## Default Variables Defaults for the following are in [./roles/ndfc_rest_fabric_info_get/defaults/main.yml](/roles/ndfc_rest_fabric_info_get/defaults/main.yml) @@ -25,7 +25,7 @@ Variable | Type | Description greenfield_debug_flag | str() | Default: enable IS_READ_ONLY | bool() | Default: false -### Example Playbook +## Example Playbook ```yaml --- @@ -42,12 +42,12 @@ IS_READ_ONLY | bool() | Default: false var: fabric_info ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_fabric_msd_child_add/README.md b/roles/ndfc_rest_fabric_msd_child_add/README.md index 67d6da6..c61bd6f 100644 --- a/roles/ndfc_rest_fabric_msd_child_add/README.md +++ b/roles/ndfc_rest_fabric_msd_child_add/README.md @@ -2,7 +2,7 @@ Add ``child_fabric`` to Multi-Site Domain (MSD) fabric ``msd_fabric`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -17,7 +17,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook Add ``child_fabric`` f1 to ``msd_fabric`` MSD @@ -32,12 +32,12 @@ Add ``child_fabric`` f1 to ``msd_fabric`` MSD msd_fabric: MSD ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_fabric_msd_child_remove/README.md b/roles/ndfc_rest_fabric_msd_child_remove/README.md index fb405dc..6ee1206 100644 --- a/roles/ndfc_rest_fabric_msd_child_remove/README.md +++ b/roles/ndfc_rest_fabric_msd_child_remove/README.md @@ -2,7 +2,7 @@ Remove child fabric ``child_fabric`` from Multi-Site Domain (MSD) fabric ``msd_fabric`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -17,7 +17,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook Remove ``child_fabric`` f1 from ``msd_fabric`` MSD @@ -32,12 +32,12 @@ Remove ``child_fabric`` f1 from ``msd_fabric`` MSD msd_fabric: MSD ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_interface_no_shutdown/README.md b/roles/ndfc_rest_interface_no_shutdown/README.md index 0eec88f..31230ef 100644 --- a/roles/ndfc_rest_interface_no_shutdown/README.md +++ b/roles/ndfc_rest_interface_no_shutdown/README.md @@ -2,7 +2,7 @@ Administratively ``no shutdown`` interface ``interface_name`` on ``device_name``. -### Role Variables +## Role Variables Variable | Type | Description ----------------|-------|------------------------------------------------ @@ -27,9 +27,9 @@ Variable | Type | Description forceShowRun | boolean | Default: ``false`` Included in the config-deploy REST call payload. inclAllMSDSwitches | boolean | Default: ``false`` Included in the config-deploy REST call payload. -### Dependencies +## Dependencies -### Example Playbooks +## Example Playbooks ```yaml --- @@ -42,12 +42,12 @@ inclAllMSDSwitches | boolean | Default: ``false`` Included in the config-deploy interface_name: Ethernet1/32 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_interface_shutdown/README.md b/roles/ndfc_rest_interface_shutdown/README.md index 55ffec4..f0d39dc 100644 --- a/roles/ndfc_rest_interface_shutdown/README.md +++ b/roles/ndfc_rest_interface_shutdown/README.md @@ -2,7 +2,7 @@ Administratively shutdown interface ``interface_name`` on ``device_name``. -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|------------------------------------------------ @@ -27,9 +27,9 @@ Variable | Type | Description forceShowRun | bool() | Default: ``false`` Included in the config-deploy REST call payload. inclAllMSDSwitches | bool() | Default: ``false`` Included in the config-deploy REST call payload. -### Dependencies +## Dependencies -### Example Playbooks +## Example Playbooks ```yaml # example_ndfc_rest_interface_shutdown.yml @@ -43,12 +43,12 @@ inclAllMSDSwitches | bool() | Default: ``false`` Included in the config-deploy R interface_name: Ethernet1/32 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_service_node_add/README.md b/roles/ndfc_rest_service_node_add/README.md index 0a84089..9335ae5 100644 --- a/roles/ndfc_rest_service_node_add/README.md +++ b/roles/ndfc_rest_service_node_add/README.md @@ -11,7 +11,7 @@ Role | service_node_type ndfc_rest_service_node_add | Firewall, ADC, VNF ndfc_service_node_create | firewall, load_balancer, virtual_network_function -### Role Variables +## Role Variables Variable | Type | Description ------------------|--------|---------------------------------------- @@ -25,7 +25,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Default Variables +## Default Variables Defaults for the following are in ``./roles/ndfc_rest_service_node_add/defaults/main.yml``: @@ -40,7 +40,7 @@ interface_bpduguard_enabled | boolean | Default: true interface_porttype_fast_enabled | boolean | Default: true interface_admin_state | boolean | true -### Example Playbook +## Example Playbook ```yaml --- @@ -52,12 +52,12 @@ interface_admin_state | boolean | true service_node_name: sn_1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_vpc_create/README.md b/roles/ndfc_rest_vpc_create/README.md index 33c9fcc..55179bb 100644 --- a/roles/ndfc_rest_vpc_create/README.md +++ b/roles/ndfc_rest_vpc_create/README.md @@ -2,7 +2,7 @@ Create vpc peering ``vpc_name`` in fabric ``fabric_name`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -20,7 +20,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -34,12 +34,12 @@ See the following for details: vpc_name: vpc2 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_vpc_delete/README.md b/roles/ndfc_rest_vpc_delete/README.md index f532054..239bc08 100644 --- a/roles/ndfc_rest_vpc_delete/README.md +++ b/roles/ndfc_rest_vpc_delete/README.md @@ -2,7 +2,7 @@ Delete vpc peering ``vpc_name`` in fabric ``fabric_name`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -16,19 +16,19 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook This currently does not work. We're investigating it and will update the repo once a resolution is found. ```yaml ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_rest_vrf_list_by_fabric/README.md b/roles/ndfc_rest_vrf_list_by_fabric/README.md index 34b6607..ccf5e2b 100644 --- a/roles/ndfc_rest_vrf_list_by_fabric/README.md +++ b/roles/ndfc_rest_vrf_list_by_fabric/README.md @@ -5,14 +5,14 @@ Retrieve list of VRFs in fabric ``fabric_name`` Returns JSON object ``info`` which will be a list of vrf dictionaries if the GET request succeeded, or an empty list if the GET request failed. -### Role Variables +## Role Variables Variable | Type | Description ----------------|-------|---------------------------------------- fabric_name | str() | The fabric to be queried -### Example Playbook +## Example Playbook The playbook below prints select information for every VRF in fabric_name f2. @@ -34,12 +34,12 @@ The playbook below prints select information for every VRF in fabric_name f2. label: vrf_info ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_service_node_config_get/README.md b/roles/ndfc_service_node_config_get/README.md index fc2c97a..c39193b 100644 --- a/roles/ndfc_service_node_config_get/README.md +++ b/roles/ndfc_service_node_config_get/README.md @@ -2,7 +2,7 @@ Retrieve local configuration for ``service_node_name`` -### Role Variables +## Role Variables Variable | Type | Description ------------------|--------|---------------------------------------- @@ -16,7 +16,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -33,12 +33,12 @@ See the following for details: var: service_node_config ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_service_node_deleted/README.md b/roles/ndfc_service_node_deleted/README.md index 216c5c0..6401c5e 100644 --- a/roles/ndfc_service_node_deleted/README.md +++ b/roles/ndfc_service_node_deleted/README.md @@ -2,7 +2,7 @@ Delete service node ``service_node_name`` -### Role Variables +## Role Variables Variable | Type | Description ------------------|--------|---------------------------------------- @@ -17,7 +17,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -29,12 +29,12 @@ See the following for details: service_node_name: sn_1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_service_node_merged/README.md b/roles/ndfc_service_node_merged/README.md index d2a575e..ace9493 100644 --- a/roles/ndfc_service_node_merged/README.md +++ b/roles/ndfc_service_node_merged/README.md @@ -13,7 +13,7 @@ Role | service_node_type ndfc_rest_service_node_add | Firewall, ADC, VNF ndfc_service_node_merged | firewall, load_balancer, virtual_network_function -### Role Variables +## Role Variables Variable | Type | Description ------------------|--------|---------------------------------------- @@ -28,7 +28,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -40,12 +40,12 @@ See the following for details: service_node_name: sn_1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_service_route_peering_config_get/README.md b/roles/ndfc_service_route_peering_config_get/README.md index ec0d556..f44a093 100644 --- a/roles/ndfc_service_route_peering_config_get/README.md +++ b/roles/ndfc_service_route_peering_config_get/README.md @@ -2,7 +2,7 @@ Retrieve configuration for ``service_route_peering_name`` from the Ansible inventory -### Role Variables +## Role Variables Variable | Type | Description ---------------------------|--------|---------------------------------------- @@ -17,7 +17,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -34,12 +34,12 @@ See the following for details: var: service_route_peering_config ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_service_route_peering_intra_tenant_fw_merged/README.md b/roles/ndfc_service_route_peering_intra_tenant_fw_merged/README.md index 1850245..8a75a23 100644 --- a/roles/ndfc_service_route_peering_intra_tenant_fw_merged/README.md +++ b/roles/ndfc_service_route_peering_intra_tenant_fw_merged/README.md @@ -4,7 +4,7 @@ Create intra-tenant service route peering NOTE 1: This role is not tested (or documented satisfactorily) yet. -### Role Variables +## Role Variables Variable | Type | Description ---------------------------|-------|---------------------------------------- @@ -19,7 +19,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -31,12 +31,12 @@ See the following for details: service_route_peering_name: srp_1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_vpc_config_get/README.md b/roles/ndfc_vpc_config_get/README.md index 7334c67..ac01e53 100644 --- a/roles/ndfc_vpc_config_get/README.md +++ b/roles/ndfc_vpc_config_get/README.md @@ -2,7 +2,7 @@ Retrieve configuration for ``vpc_name`` from the local inventory -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -16,7 +16,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -28,12 +28,12 @@ See the following for details: vpc_name: vpc1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_vpc_interface_merged_all/README.md b/roles/ndfc_vpc_interface_merged_all/README.md index 9240daa..1cc2d14 100644 --- a/roles/ndfc_vpc_interface_merged_all/README.md +++ b/roles/ndfc_vpc_interface_merged_all/README.md @@ -2,7 +2,7 @@ Merge all vpc interfaces for vpc peer ``vpc_name`` -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -16,7 +16,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -29,12 +29,12 @@ See the following for details: vpc_name: vpc1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_vrf_all/README.md b/roles/ndfc_vrf_all/README.md index 565d9fb..31ea29b 100644 --- a/roles/ndfc_vrf_all/README.md +++ b/roles/ndfc_vrf_all/README.md @@ -2,14 +2,14 @@ Create, update, or delete all defined VRFs in fabric ``fabric_name``. -### Role Variables +## Role Variables Variable | Description ------------ | ----------- fabric_name | The name of the fabric in which the VRFs reside.
Typically defined in the playbook's vars: section. state | Ansible state. One of merged, overridden, replaced, or deleted. -### Other variables +## Other variables This role reads the ``vrfs`` dictionary from: @@ -33,9 +33,10 @@ service_vrf_template | ServiceVrf | string | 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 Playbooks +## Example Playbooks + +### delete all vrf in fabric f2 -##### delete all vrf in fabric f2 ```yaml --- - hosts: ndfc @@ -49,7 +50,8 @@ attach.ip_address | 192.168.1.1 | IP address | mgmt0 address of the sw state: deleted ``` -##### merge all vrf in fabric f1 +### merge all vrf in fabric f1 + ```yaml --- - hosts: ndfc @@ -63,7 +65,7 @@ attach.ip_address | 192.168.1.1 | IP address | mgmt0 address of the sw state: merged ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. diff --git a/roles/ndfc_vrf_config_get/README.md b/roles/ndfc_vrf_config_get/README.md index 1c466a5..3884afe 100644 --- a/roles/ndfc_vrf_config_get/README.md +++ b/roles/ndfc_vrf_config_get/README.md @@ -2,13 +2,13 @@ Retrieve the configuration for vrf ``vrf_name`` -### Returns (via set_fact) +## Returns (via set_fact) Variable | Type | Description ----------------|--------|---------------------------------------- vrf_config | object | A JSON object containing ``vrf_name``'s current configuration -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -22,7 +22,7 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) -### Example Playbook +## Example Playbook ```yaml --- @@ -38,7 +38,7 @@ See the following for details: var: vrf_config ``` -### Example returned object +## Example returned object ```json { @@ -94,12 +94,13 @@ See the following for details: } } ``` -### Licensing + +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_vrf_query/README.md b/roles/ndfc_vrf_query/README.md index ab303c4..14a25f7 100644 --- a/roles/ndfc_vrf_query/README.md +++ b/roles/ndfc_vrf_query/README.md @@ -2,7 +2,7 @@ Query VRF ``vrf_name`` and return json object ``vrf_info`` which contains vrf information for ``vrf_name`` from the NDFC controller. -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -14,7 +14,7 @@ VRF parameters are defined in the following files: NOTE, ``vrf_name`` above corresponds to the ``name:`` key within the vrfs dictionary in the file noted above. The ``name:`` key is unique across all defined vrfs, whereas the ``vrf_name:`` key is not unique and cannot be used with this role. By way of example, in the entry below, you would use the value of ``name:`` rather than the value of ``vrf_name``. The example playbook below shows the correct value to use. -#### Example entry in the vrfs dictionary +## Example entry in the vrfs dictionary ```yaml f2_v1: @@ -33,7 +33,7 @@ NOTE, ``vrf_name`` above corresponds to the ``name:`` key within the vrfs dictio - ip_address: "{{ devices.leaf_8.ip }}" ``` -#### Example playbook to query the above vrf +### Example playbook to query the above vrf ```yaml --- @@ -56,12 +56,12 @@ See the following for details: [./inventory/group_vars/README.md](https://github.com/allenrobel/ndfc-roles/tree/master/inventory/group_vars/README.md) -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_vrf_replaced/README.md b/roles/ndfc_vrf_replaced/README.md index 72ebb81..5b12520 100644 --- a/roles/ndfc_vrf_replaced/README.md +++ b/roles/ndfc_vrf_replaced/README.md @@ -2,7 +2,7 @@ Replace vrf ``vrf_name`` in fabric ``fabric_name`` with the current user-defined parameters. -### Role Variables +## Role Variables Variable | Type | Description ----------------|--------|---------------------------------------- @@ -34,7 +34,7 @@ service_vrf_template | ServiceVrf | string | Service vrf temp 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 dictionary +## Example entry in vrfs dictionary ```yaml vrfs: @@ -56,7 +56,7 @@ vrfs: - ip_address: "{{ devices.leaf_8.ip }}" ``` -## Example Playbook (referencing the above example vrf entry) +### Example Playbook (referencing the above example vrf entry) ```yaml --- @@ -68,12 +68,12 @@ vrfs: vrf_name: f2_v1 ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) From 5f51fc2797f17d33a60b324a4812adfa37f06b37 Mon Sep 17 00:00:00 2001 From: Allen Robel Date: Fri, 12 Jul 2024 08:09:13 -1000 Subject: [PATCH 4/5] More markdown fixes. --- README.md | 7 +- inventory/group_vars/README.md | 64 ++++++++++--------- roles/ndfc_device_config_get/README.md | 1 - .../README.md | 1 - .../README.md | 1 - roles/ndfc_device_info_get/README.md | 2 +- .../README.md | 1 - .../README.md | 2 +- .../README.md | 2 +- roles/ndfc_device_list_get/README.md | 2 +- roles/ndfc_device_names_get/README.md | 3 +- roles/ndfc_network_replaced/README.md | 1 - .../ndfc_policy_vrf_rt_import_evpn/README.md | 3 +- .../README.md | 7 +- roles/ndfc_rest_device_rediscover/README.md | 1 - roles/ndfc_rest_vrf_list_by_fabric/README.md | 1 - roles/ndfc_service_node_deleted/README.md | 1 - roles/ndfc_service_node_merged/README.md | 1 - .../README.md | 1 - .../README.md | 1 - roles/ndfc_vrf_all/README.md | 4 +- 21 files changed, 48 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index 5b0f1b5..0602ecc 100644 --- a/README.md +++ b/README.md @@ -88,8 +88,8 @@ The characteristics of the child/site fabrics are as follows (see also the inclu - 2 spine acting as Route Reflectors for all leaf and border_gateway - Either: - - 4 VPC leaf (2 VPC pairs using fabric-peering for their virtual peer-link) - - Or, 2 non-VPC leaf + - 4 VPC leaf (2 VPC pairs using fabric-peering for their virtual peer-link) + - Or, 2 non-VPC leaf - 2 border_gateway - 2 VRF: v1 and v2 - L3 (ipv4 / ipv6) connectivity between VRF v1 and v2 (symmetric import of route-targets) @@ -205,7 +205,6 @@ ndfc: ansible_host: 192.168.1.1 ``` - #### To run a playbook if you encrypted your NDFC password ```bash @@ -230,7 +229,6 @@ Role naming conventions used in this repo. 2. If a Role requires the user to provide the Ansible state, the Role's name does not include the state. 3. If a Role uses the NDFC REST API, its name includes ``_rest_`` (e.g. ``ndfc_rest_device_rediscover``) - Role | Description ------------ | ----------- [ndfc_device_config_get] | Retrieve local configuration for device, given ``device_name`` @@ -295,7 +293,6 @@ Role | Description [ndfc_vrf_query] | Retrieve NDFC controller configuration for VRF in json object ``vrf_info``, given ``vrf_name`` [ndfc_vrf_replaced] | Update (replaced) a vrf, given ``vrf_name`` - [ndfc_device_config_get]: https://github.com/allenrobel/ndfc-roles/tree/master/roles/ndfc_device_config_get [ndfc_device_deleted]: https://github.com/allenrobel/ndfc-roles/tree/master/roles/ndfc_device_deleted [ndfc_device_deleted_all]: https://github.com/allenrobel/ndfc-roles/tree/master/roles/ndfc_device_deleted_all diff --git a/inventory/group_vars/README.md b/inventory/group_vars/README.md index f27c24f..bd26671 100644 --- a/inventory/group_vars/README.md +++ b/inventory/group_vars/README.md @@ -2,13 +2,13 @@ Contains vars required by ndfc_* roles -### Requirements +## Requirements json_query (``pip install jmespath``) -### 01_fabrics.yml +## 01_fabrics.yml -#### lan_classic_fabrics +### lan_classic_fabrics A dictionary of dictionaries. Some of the more frequently-used variables are: @@ -20,7 +20,7 @@ FABRIC_NAME | LC_1 | string | Fabric name LOOPBACK0_IP_RANGE | 10.201.0.0/22 | string | prefix/mask defining DCI loopback address range IS_READ_ONLY | false | boolean | If ``true`` the fabric will be created in monitor mode and no edits can be made to it. If ``false``, the fabric will be created in read/write mode. -##### Example +#### Example ```yaml lan_classic: @@ -84,9 +84,9 @@ lan_classic: BOOTSTRAP_ENABLE: false ``` -#### easy_fabric +### VXLAN/EVPN Fabrics -aka. VXLAN/EVPN Fabrics +aka. easy_fabric A dictionary of dictionaries. Some of the more frequently-used variables are: @@ -108,7 +108,7 @@ NOTE: variables below (mis)spelled DEAFULT_* e.g. DEAFULT_QUEUING_POLICY_CLOUDSC are correct (i.e. NDFC expects these to be spelled incorrectly). A bug to fix these was filed, but was Closed with no action taken. -##### Example +#### Example ```yaml easy_fabric: @@ -356,7 +356,7 @@ easy_fabric: ANYCAST_RP_IP_RANGE: "" ``` -#### msd - Multisite Domain Fabrics +### msd - Multisite Domain Fabrics A dictionary of dictionaries. Some of the more frequently-used variables are: @@ -376,7 +376,7 @@ LOOPBACK100_IP_RANGE | 10.100.0.0/24 | net/prefix | range for BGW loopback i MS_LOOPBACK_ID | 100 | integer | loopback ID for the multisite loopback interface. min: 0, max: 1023 MS_UNDERLAY_AUTOCONFIG | true | boolean | Enable ``true`` or disable ``false`` the multi-site underlay autoconfiguration -##### Example +#### Example ```yaml msd: @@ -435,7 +435,7 @@ msd: ``` -#### external - External Fabrics +### external - External Fabrics A dictionary of dictionaries. Some of the more frequently-used variables are: @@ -451,7 +451,7 @@ LOOPBACK0_IP_RANGE | 10.201.0.0/22 | string | prefix/mask defining DCI l POWER_REDUNDANCY_MODE | ps-redundant | string | ps-redundant,combined,insrc-redundant SUBINTERFACE_RANGE | 2-512 | string | Per Border Dot1q Range For VRF Lite Connectivity (Min:2, Max:4093) -##### Example +#### Example ```yaml external: @@ -521,9 +521,9 @@ external: BOOTSTRAP_ENABLE: false ``` -### 02_devices.yml +## 02_devices.yml -#### devices +### devices A dictionary of dictionaries The dictionaries all have the same format. @@ -538,7 +538,7 @@ preserve_config | false | boolean | If false, write erase the c role | leaf | string | The role of the switch. switch_fabric | fabric_1 | string | Fabric in which the switch resides -##### Example +#### Example ```yaml devices: @@ -568,13 +568,13 @@ devices: ``` -### 03_networks.yaml +## 03_networks.yaml -#### port_groups +### port_groups Dictionary containing lists of ports to which networks are attached. These are referenced with the ``networks`` dictionary -##### Example +#### Example ```yaml port_groups: @@ -584,7 +584,7 @@ port_groups: - Port-channel12 ``` -#### networks +### networks Dictionary of dictionaries which define networks and their attachments (device + port_group). @@ -600,7 +600,7 @@ attach.ip_address | 192.168.1.1 | IP address | mgmt0 address of the swi attach.ports | See example | list | list of ports on the switch to which the network is attached -##### Example +#### Example Below, network n1111 (10.21.1.0/24), with gateway 10.21.1.1, in fabric f1, is connected to four leafs on port port-channel11 on each leaf, within vrf v1. @@ -643,9 +643,9 @@ networks: ports: "{{ port_groups.pg12 }}" ``` -### 04_vrfs.yml +## 04_vrfs.yml -#### vrfs +### vrfs Dictionary which define VRFs and their attachments (device). This follows the same property names and (more or less) the general structure as the corresponding Ansible [cisco.dcnm_vrf](https://github.com/CiscoDevNet/ansible-dcnm/blob/main/docs/cisco.dcnm.dcnm_vrf_module.rst) module. @@ -664,7 +664,7 @@ service_vrf_template | ServiceVrf | string | 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 +#### Example ```yaml vrfs: f1_v1: @@ -705,9 +705,9 @@ vrfs: - ip_address: "{{ devices.leaf_4.ip }}" ``` -### 05_vpc.yml +## 05_vpc.yml -#### vpc_peers +### vpc_peers Variable | Example | Type | Description --------------------|----------------|--------------|------------------- @@ -715,7 +715,7 @@ vpc_name | vpc_1 | string | name of the VPC peering re peer_1 | leaf_1 | string | Name of vpc peer 1 (from devices dictionary) peer_2 | leaf_2 | string | Name of vpc peer 2 (from devices dictionary) -##### Example +#### Example ```yaml vpc_peers: @@ -729,7 +729,7 @@ vpc_peers: peer_2: leaf_4 ``` -#### vpc_interfaces +### vpc_interfaces Variable | Example | Type | Description -----------------------|------------------|---------|------------------- @@ -743,7 +743,7 @@ vpc_port_id | vpi11 | string | User-provided name. Can b peer1_allowed_vlans | 1111 | string | Valid values: none, all, or comma-separated list of allowed vlans e.g. 2-11,12,45-50 peer2_allowed_vlans | 1111 | string | Valid values: none, all, or comma-separated list of allowed vlans e.g. 2-11,12,45-50 -##### Example +#### Example ```yaml vpc_interfaces: @@ -774,10 +774,12 @@ vpc_interfaces: - Ethernet1/12 ``` -### 06_service_nodes.yml +## 06_service_nodes.yml List of dictionaries which define Service Nodes +### service_nodes + Variable | Example | Type | Description ----------------------|--------------------|--------------|------------------- external_fabric_name | ext_fabric_1 | string | External Fabric in which service node resides @@ -797,7 +799,7 @@ interface_bpduguard_enabled | true | boolean | Enable BPDU guard on ``at interface_porttype_fast_enabled | false | boolean | Enable port fast on ``attached_switch_interface_name`` interface_admin_state | true | boolean | Admin state for ``attached_switch_interface_name`` -##### Example +#### Example ```yaml service_nodes: @@ -821,12 +823,12 @@ service_nodes: ``` -### Licensing +## Licensing GNU General Public License v3.0 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. -### Author Information +## Author Information Allen Robel (@packetcalc) diff --git a/roles/ndfc_device_config_get/README.md b/roles/ndfc_device_config_get/README.md index 99166f5..8887d48 100644 --- a/roles/ndfc_device_config_get/README.md +++ b/roles/ndfc_device_config_get/README.md @@ -16,7 +16,6 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) - ## Example Playbook ```yaml diff --git a/roles/ndfc_device_generated_configs_all_get/README.md b/roles/ndfc_device_generated_configs_all_get/README.md index bad5c9e..d69a80d 100644 --- a/roles/ndfc_device_generated_configs_all_get/README.md +++ b/roles/ndfc_device_generated_configs_all_get/README.md @@ -17,7 +17,6 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) - ## Example Playbook ```yaml diff --git a/roles/ndfc_device_generated_configs_get/README.md b/roles/ndfc_device_generated_configs_get/README.md index 6379ecf..d2a7525 100644 --- a/roles/ndfc_device_generated_configs_get/README.md +++ b/roles/ndfc_device_generated_configs_get/README.md @@ -19,7 +19,6 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) - ## Example Playbook ```yaml diff --git a/roles/ndfc_device_info_get/README.md b/roles/ndfc_device_info_get/README.md index 30c2e38..cad22c0 100644 --- a/roles/ndfc_device_info_get/README.md +++ b/roles/ndfc_device_info_get/README.md @@ -183,4 +183,4 @@ As of NDFC version 12.0.1 "wwn": null } } -``` \ No newline at end of file +``` diff --git a/roles/ndfc_device_interface_config_all_get/README.md b/roles/ndfc_device_interface_config_all_get/README.md index 403091a..032189b 100644 --- a/roles/ndfc_device_interface_config_all_get/README.md +++ b/roles/ndfc_device_interface_config_all_get/README.md @@ -18,7 +18,6 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) - ## Example Playbook ```yaml diff --git a/roles/ndfc_device_ipv4_address_local_get/README.md b/roles/ndfc_device_ipv4_address_local_get/README.md index e1775f0..a0938fb 100644 --- a/roles/ndfc_device_ipv4_address_local_get/README.md +++ b/roles/ndfc_device_ipv4_address_local_get/README.md @@ -52,4 +52,4 @@ See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. ## Author Information -Allen Robel (@packetcalc) \ No newline at end of file +Allen Robel (@packetcalc) diff --git a/roles/ndfc_device_ipv4_address_remote_get/README.md b/roles/ndfc_device_ipv4_address_remote_get/README.md index 631fc26..238b0b7 100644 --- a/roles/ndfc_device_ipv4_address_remote_get/README.md +++ b/roles/ndfc_device_ipv4_address_remote_get/README.md @@ -52,4 +52,4 @@ See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) for full text. ## Author Information -Allen Robel (@packetcalc) \ No newline at end of file +Allen Robel (@packetcalc) diff --git a/roles/ndfc_device_list_get/README.md b/roles/ndfc_device_list_get/README.md index ce27ca6..897b930 100644 --- a/roles/ndfc_device_list_get/README.md +++ b/roles/ndfc_device_list_get/README.md @@ -6,7 +6,7 @@ Retrieve device configuration from the local inventory for all devices in fabric A JSON list of objects containing device configurations, including seed_ip, role, password, username. -### Example structure of returned information: +### Example structure of returned information ```json [ diff --git a/roles/ndfc_device_names_get/README.md b/roles/ndfc_device_names_get/README.md index 4fe9869..2a45ce8 100644 --- a/roles/ndfc_device_names_get/README.md +++ b/roles/ndfc_device_names_get/README.md @@ -14,11 +14,10 @@ Fabric and device parameters are defined in the following files: - ./inventory/group_vars/ndfc/01_fabrics.yml - ./inventory/group_vars/ndfc/02_devices.yml -See the following for details: +See the following for details. [./inventory/group_vars/README.md](https://github.com/allenrobel/ndfc-roles/tree/master/inventory/group_vars/README.md) - ## Example Playbook ```yaml diff --git a/roles/ndfc_network_replaced/README.md b/roles/ndfc_network_replaced/README.md index 335eea5..6e5957f 100644 --- a/roles/ndfc_network_replaced/README.md +++ b/roles/ndfc_network_replaced/README.md @@ -16,7 +16,6 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) - ## Example Playbook ```yaml diff --git a/roles/ndfc_policy_vrf_rt_import_evpn/README.md b/roles/ndfc_policy_vrf_rt_import_evpn/README.md index 3bbf36f..0d8e706 100644 --- a/roles/ndfc_policy_vrf_rt_import_evpn/README.md +++ b/roles/ndfc_policy_vrf_rt_import_evpn/README.md @@ -2,7 +2,8 @@ Import vrf ``import_vrf_name``'s route-targets into vrf ``vrf_name`` on device ``device_name`` using Ansible state ``state`` -NOTE: This role isn't needed when route-target imports are added to a VRF's config. See the following: +NOTE: This role isn't needed when route-target imports are added to a VRF's config. See the following. + - [./inventory/group_vars/README.md](/inventory/group_vars/README.md) - [./inventory/group_vars/ndfc/04_vrfs.yml](/inventory/group_vars/ndfc/04_vrfs.yml) diff --git a/roles/ndfc_policy_vrf_rt_import_evpn_loop/README.md b/roles/ndfc_policy_vrf_rt_import_evpn_loop/README.md index 232ac52..5e1c43f 100644 --- a/roles/ndfc_policy_vrf_rt_import_evpn_loop/README.md +++ b/roles/ndfc_policy_vrf_rt_import_evpn_loop/README.md @@ -4,7 +4,8 @@ Import vrf ``import_vrf_name``'s route-targets into vrf ``vrf_name`` on multiple NOTE 1: This role will fail the first time it's run, but is written to retry and will succeed on the second retry. This is offered as a hack until the DCNM Ansible Collection provides a way to configure route-target import/export within the dcnm_vrf module (or some other yet-to-be-created module). -NOTE 2: This role isn't needed when route-target imports are added to a VRF's config. See the following: +NOTE 2: This role isn't needed when route-target imports are added to a VRF's config. See the following. + - [./inventory/group_vars/README.md](/inventory/group_vars/README.md) - [./inventory/group_vars/ndfc/04_vrfs.yml](/inventory/group_vars/ndfc/04_vrfs.yml) @@ -12,13 +13,13 @@ NOTE 2: This role isn't needed when route-target imports are added to a VRF's co Variable | Type | Description ----------------|--------|---------------------------------------- -fabric_name | string | The fabric in which ``device_name`` resides (see devices list below). NOTE: if ``device_name`` resides in a child fabric of an MSD fabric, then ``fabric_name`` must be the name of the MSD fabric. +fabric_name | string | The fabric in which ``device_name`` resides (see devices list below). NOTE: if ``device_name`` resides in a child fabric of an MSD fabric, then ``fabric_name`` must be the name of the MSD fabric. vrf_name | string | The vrf into which ``import_vrf_name``'s route-targets will be imports import_vrf_name | string | The vrf whose route-targets will be imported into ``vrf_name`` state | string | The Ansible state to apply for the import. e.g. ``deleted`` to delete the import, ``merged`` to merge the import. NOTE: ``replaced`` is not a valid state for this module. device_list | list | An Ansible list of ``device_name`` to which ``vrf_name`` is attached -Fabric, device and VRF parameters are defined in the following files: +Fabric, device and VRF parameters are defined in the following files. - [./inventory/group_vars/ndfc/01_fabrics.yml](/inventory/group_vars/ndfc/01_fabrics.yml) - [./inventory/group_vars/ndfc/02_devices.yml](/inventory/group_vars/ndfc/02_devices.yml) diff --git a/roles/ndfc_rest_device_rediscover/README.md b/roles/ndfc_rest_device_rediscover/README.md index cfc217c..2311f54 100644 --- a/roles/ndfc_rest_device_rediscover/README.md +++ b/roles/ndfc_rest_device_rediscover/README.md @@ -18,7 +18,6 @@ See the following for details: [./inventory/group_vars/README.md](https://github.com/allenrobel/ndfc-roles/tree/master/inventory/group_vars/README.md) - ## Example Playbook ```yaml diff --git a/roles/ndfc_rest_vrf_list_by_fabric/README.md b/roles/ndfc_rest_vrf_list_by_fabric/README.md index ccf5e2b..8a6d305 100644 --- a/roles/ndfc_rest_vrf_list_by_fabric/README.md +++ b/roles/ndfc_rest_vrf_list_by_fabric/README.md @@ -11,7 +11,6 @@ Variable | Type | Description ----------------|-------|---------------------------------------- fabric_name | str() | The fabric to be queried - ## Example Playbook The playbook below prints select information for every VRF in fabric_name f2. diff --git a/roles/ndfc_service_node_deleted/README.md b/roles/ndfc_service_node_deleted/README.md index 6401c5e..f7e400d 100644 --- a/roles/ndfc_service_node_deleted/README.md +++ b/roles/ndfc_service_node_deleted/README.md @@ -16,7 +16,6 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) - ## Example Playbook ```yaml diff --git a/roles/ndfc_service_node_merged/README.md b/roles/ndfc_service_node_merged/README.md index ace9493..37aeac2 100644 --- a/roles/ndfc_service_node_merged/README.md +++ b/roles/ndfc_service_node_merged/README.md @@ -27,7 +27,6 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) - ## Example Playbook ```yaml diff --git a/roles/ndfc_service_route_peering_config_get/README.md b/roles/ndfc_service_route_peering_config_get/README.md index f44a093..d8d077e 100644 --- a/roles/ndfc_service_route_peering_config_get/README.md +++ b/roles/ndfc_service_route_peering_config_get/README.md @@ -16,7 +16,6 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) - ## Example Playbook ```yaml diff --git a/roles/ndfc_service_route_peering_intra_tenant_fw_merged/README.md b/roles/ndfc_service_route_peering_intra_tenant_fw_merged/README.md index 8a75a23..fa28e65 100644 --- a/roles/ndfc_service_route_peering_intra_tenant_fw_merged/README.md +++ b/roles/ndfc_service_route_peering_intra_tenant_fw_merged/README.md @@ -18,7 +18,6 @@ See the following for details: [./inventory/group_vars/README.md](/inventory/group_vars/README.md) - ## Example Playbook ```yaml diff --git a/roles/ndfc_vrf_all/README.md b/roles/ndfc_vrf_all/README.md index 31ea29b..9976172 100644 --- a/roles/ndfc_vrf_all/README.md +++ b/roles/ndfc_vrf_all/README.md @@ -6,7 +6,7 @@ Create, update, or delete all defined VRFs in fabric ``fabric_name``. Variable | Description ------------ | ----------- -fabric_name | The name of the fabric in which the VRFs reside.
Typically defined in the playbook's vars: section. +fabric_name | The name of the fabric in which the VRFs reside. Typically defined in the playbook's ``vars`` section. state | Ansible state. One of merged, overridden, replaced, or deleted. ## Other variables @@ -26,7 +26,7 @@ import_vpn_rt | 65000:50001 | string | vpn route-target to imp import_evpn_rt | 65000:50001 | string | evpn route-target to import vrf_name | vrf_1 | string | name of the vrf vrf_id | 9003031 | integer | vrf Layer3 VNI / vn-segment -vlan_id | 3031 | integer | vrf associated vlan +vlan_id | 3031 | integer | vrf associated vlan vrf_template | TemplateVrf | string | Overlay VRF Template For Leafs vrf_extension_template | TemplateExVrf | string | Overlay VRF Template For Borders service_vrf_template | ServiceVrf | string | Service vrf template From 7dd752cf57a2afaeb07e394e798810db600562f9 Mon Sep 17 00:00:00 2001 From: Allen Robel Date: Fri, 12 Jul 2024 08:31:42 -1000 Subject: [PATCH 5/5] More markdown fixes. --- CODE_OF_CONDUCT.md | 6 +++--- inventory/group_vars/README.md | 10 ++++------ 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 70d0f60..225e5fc 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -116,7 +116,7 @@ the community. This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at -https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. +[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html). Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). @@ -124,5 +124,5 @@ enforcement ladder](https://github.com/mozilla/diversity). [homepage]: https://www.contributor-covenant.org For answers to common questions about this code of conduct, see the FAQ at -https://www.contributor-covenant.org/faq. Translations are available at -https://www.contributor-covenant.org/translations. +[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at +[https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). diff --git a/inventory/group_vars/README.md b/inventory/group_vars/README.md index bd26671..a767778 100644 --- a/inventory/group_vars/README.md +++ b/inventory/group_vars/README.md @@ -434,7 +434,6 @@ msd: scheduledTime: "" ``` - ### external - External Fabrics A dictionary of dictionaries. Some of the more frequently-used variables are: @@ -524,6 +523,7 @@ external: ## 02_devices.yml ### devices + A dictionary of dictionaries The dictionaries all have the same format. @@ -567,7 +567,6 @@ devices: preserve_config: false ``` - ## 03_networks.yaml ### port_groups @@ -599,7 +598,6 @@ attach | See example | list of dict | List of dictionaries def attach.ip_address | 192.168.1.1 | IP address | mgmt0 address of the switch to which the network is attached attach.ports | See example | list | list of ports on the switch to which the network is attached - #### Example Below, network n1111 (10.21.1.0/24), with gateway 10.21.1.1, in fabric f1, is connected to four leafs on port port-channel11 on each leaf, within vrf v1. @@ -657,7 +655,7 @@ import_vpn_rt | 65000:50001 | string | vpn route-target to imp import_evpn_rt | 65000:50001 | string | evpn route-target to import vrf_name | vrf_1 | string | name of the vrf vrf_id | 9003031 | integer | vrf Layer3 VNI / vn-segment -vlan_id | 3031 | integer | vrf associated vlan +vlan_id | 3031 | integer | vrf associated vlan vrf_template | TemplateVrf | string | Overlay VRF Template For Leafs vrf_extension_template | TemplateExVrf | string | Overlay VRF Template For Borders service_vrf_template | ServiceVrf | string | Service vrf template @@ -665,6 +663,7 @@ attach | See example | list of dict | List of mgmt0 ip addres attach.ip_address | 192.168.1.1 | IP address | mgmt0 address of the switch to which the vrf is attached #### Example + ```yaml vrfs: f1_v1: @@ -791,7 +790,7 @@ attached_fabric_name | f1 | string | fabric in which ``attache attached_switch_name | leaf_1 | string | name of the switch attached to service node attached_switch_interface_name | Eth1/5 | string | name of the interface on ``attached_switch_name`` connecting to service node vpc_switches_attached | false | boolean | Is service node attached to VPC switches? -link_template_name | service_link_trunk | string | Template used to configure ``attached_switch_interface_name`` +link_template_name | service_link_trunk | string | Template used to configure ``attached_switch_interface_name`` interface_speed | Auto | string | Speed of ``attached_switch_interface_name`` interface_mtu | jumbo | string | MTU of ``attached_switch_interface_name`` interface_allowed_vlans | all | string | Valid values: all, none. Allowed vlans on ``attached_switch_interface_name`` @@ -822,7 +821,6 @@ service_nodes: interface_admin_state: true ``` - ## Licensing GNU General Public License v3.0 or later.