Adding upstream version 0.13.0.

Signed-off-by: Daniel Baumann <daniel@debian.org>
2025-02-05 11:32:35 +01:00 · 2025-02-05 11:32:35 +01:00 · ecf5ca3300
commit ecf5ca3300
parent c0ae77e0f6
272 changed files with 33172 additions and 0 deletions
--- a/docs/cli/inv-from-cvp.md
+++ b/docs/cli/inv-from-cvp.md
@ -0,0 +1,72 @@
+<!--
+  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
+# Create an Inventory from CloudVision
+
+In large setups, it might be beneficial to construct your inventory based on CloudVision. The `from-cvp` entrypoint of the `get` command enables the user to create an ANTA inventory from CloudVision.
+
+### Command overview
+
+```bash
+anta get from-cvp --help
+Usage: anta get from-cvp [OPTIONS]
+
+  Build ANTA inventory from Cloudvision
+
+Options:
+  -ip, --cvp-ip TEXT              CVP IP Address  [required]
+  -u, --cvp-username TEXT         CVP Username  [required]
+  -p, --cvp-password TEXT         CVP Password / token  [required]
+  -c, --cvp-container TEXT        Container where devices are configured
+  -d, --inventory-directory PATH  Path to save inventory file
+  --help                          Show this message and exit.
+```
+
+The output is an inventory where the name of the container is added as a tag for each host:
+
+```yaml
+anta_inventory:
+  hosts:
+  - host: 192.168.0.13
+    name: leaf2
+    tags:
+    - pod1
+  - host: 192.168.0.15
+    name: leaf4
+    tags:
+    - pod2
+```
+
+!!! warning
+    The current implementation only considers devices directly attached to a specific container when using the `--cvp-container` option.
+
+### Creating an inventory from multiple containers
+
+If you need to create an inventory from multiple containers, you can use a bash command and then manually concatenate files to create a single inventory file:
+
+```bash
+$ for container in pod01 pod02 spines; do anta get from-cvp -ip <cvp-ip> -u cvpadmin -p cvpadmin -c $container -d test-inventory; done
+
+[12:25:35] INFO     Getting auth token from cvp.as73.inetsix.net for user tom
+[12:25:36] INFO     Creating inventory folder /home/tom/Projects/arista/network-test-automation/test-inventory
+           WARNING  Using the new api_token parameter. This will override usage of the cvaas_token parameter if both are provided. This is because api_token and cvaas_token parameters
+                    are for the same use case and api_token is more generic
+           INFO     Connected to CVP cvp.as73.inetsix.net
+
+
+[12:25:37] INFO     Getting auth token from cvp.as73.inetsix.net for user tom
+[12:25:38] WARNING  Using the new api_token parameter. This will override usage of the cvaas_token parameter if both are provided. This is because api_token and cvaas_token parameters
+                    are for the same use case and api_token is more generic
+           INFO     Connected to CVP cvp.as73.inetsix.net
+
+
+[12:25:38] INFO     Getting auth token from cvp.as73.inetsix.net for user tom
+[12:25:39] WARNING  Using the new api_token parameter. This will override usage of the cvaas_token parameter if both are provided. This is because api_token and cvaas_token parameters
+                    are for the same use case and api_token is more generic
+           INFO     Connected to CVP cvp.as73.inetsix.net
+
+           INFO     Inventory file has been created in /home/tom/Projects/arista/network-test-automation/test-inventory/inventory-spines.yml
+```