update aruba ansible playbook CASMNET-2026

README.md

@@ -1,4 +1,4 @@
-# 🛶 CANU v1.6.27
+# 🛶 CANU v1.6.29
 
 CANU (CSM Automatic Network Utility) will float through a Shasta network and make switch setup and validation a breeze.
 
@@ -1313,6 +1313,32 @@ Version      : GL.10.09.0010
 ^^^^ END netmiko_send_command ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 ```
 
+## Using `canu-inventory` with Ansible
+
+`canu-inventory` is a dynamic inventory script that queries a `sls_input_file.json` in the working directory, or an API gateway (`$SLS_API_GW`).  It can be called directly to print the information or it can be passed as an argument to `ansible-inventory`.
+
+- `$SLS_API_GW` and `$SLS_TOKEN` (or `$TOKEN`) must be set in order to query the API.
+- `$SWITCH_USERNAME` and `$SWITCH_PASSWORD` must be set in order to execute playbooks.
+- `ANSIBLE_HOST_KEY_CHECKING=False` can be set to ignore host key checking.
+- `-e config_folder` should be set to the directory containing the switch configs.
+
+```bash
+# examples
+ansible-inventory -i canu-inventory --list
+ansible-playbook -i canu-inventory aruba-aoscx.yml -e config_folder=/switch_configs
+```
+
+When running the playbook you may need to input the full path to `canu-inventory`, the playbook, and the switch configs.
+
+```bash
+# example
+ansible-playbook -i /Users/lucasbates/canu-container/venv/bin/canu-inventory /Users/lucasbates/canu-container/canu/canu/inventory/plays/aruba-aoscx.yml -e config_folder=/Users/lucasbates/canu-container/canu
+```
+
+If using the API, `$TOKEN` or `$SLS_TOKEN` need to be set.
+
+If running this from outside the cluster over the CMN, `$REQUESTS_CA_BUNDLE` needs to be set
+
 ## Uninstallation
 
 `pip3 uninstall canu`
@@ -1351,13 +1377,33 @@ To reuse a session without reinstalling dependencies use the `-rs` flag instead
 
 # Changelog
 
-## [1.6.26]
+## [1.6.30]
+
+- Updated Aruba ansible playbook and documentation.
+- Added ansible play to retain mgmt interface configuration.  This will help avoid lockouts.
+- Added ansible play utilize the aruba checkpoint feature.  This will revert the switch config after 1 minute if the switch becomes unresponsive. 
+
+## [1.6.29]
+
+- Added dynamic ansible inventory script, installed as `canu-inventory`.
+- Added a playbook to validate/upload a config.
+
+## [1.6.28]
+
+- Fix a bug where `bmc` slots were allowed non-existent port `3`.
+- Remove confusing references to "bi-directional" in warnings and errors.
+- Change versioning of flake8-commas to break dependency loop.
+- Add logging to `validate paddle`.
+- Begin refactoring the model to better validate and pick slot/port/speed requests.
+- Enhance node connection exception messaging in the model.
+
+## [1.6.27]
 
 - Fix login node shasta name for v1 architecture
 
 ## [1.6.26]
 
-- Added gpu and kvm node definitions to v1 arrchitecture.
+- Added gpu and kvm node definitions to v1 architecture.
 - Added logging to `canu generate switch/network config` to clean up output.
 - Provided better messaging about next-step handling of missing configs in generated files.
 

canu.spec

@@ -54,13 +54,15 @@ chown -R --reference=. ./dist/linux
 %install
 mkdir -p %{buildroot}%{_bindir}
 install -m 755 dist/linux/canu %{buildroot}%{_bindir}/canu
+install -m 755 dist/linux/canu-inventory %{buildroot}%{_bindir}/canu-inventory
 
 %pre
 getent passwd canu >/dev/null || \
     useradd -U -m -s /bin/bash -c "CANU user" canu
 
 %files
 %attr(755, canu, canu) %{_bindir}/canu
+%attr(755, canu, canu) %{_bindir}/canu-inventory
 %license LICENSE
 
 %changelog

canu/inventory/__init__.py

@@ -0,0 +1,22 @@
+# MIT License
+#
+# (C) Copyright [2022] Hewlett Packard Enterprise Development LP
+#
+# Permission is hereby granted, free of charge, to any person obtaining a
+# copy of this software and associated documentation files (the "Software"),
+# to deal in the Software without restriction, including without limitation
+# the rights to use, copy, modify, merge, publish, distribute, sublicense,
+# and/or sell copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+"""CANU."""