1 files changed, 87 insertions, 0 deletions
diff --git a/examples/basic.py b/examples/basic.py
new file mode 100644
index 0000000..3a275f4
--- /dev/null
+++ b/examples/basic.py
@@ -0,0 +1,87 @@
+"""Basic pyvyos usage example.
+
+Run with environment variables loaded from a .env file (see ../.env.example)
+or exported in your shell:
+
+    VYDEVICE_HOSTNAME=192.0.2.1 \\
+    VYDEVICE_APIKEY=secret \\
+    python examples/basic.py
+"""
+
+import os
+import pprint
+import random
+import string
+
+from dotenv import load_dotenv
+
+from pyvyos import VyDevice
+
+load_dotenv()
+
+
+def make_device() -> VyDevice:
+    return VyDevice(
+        hostname=os.environ["VYDEVICE_HOSTNAME"],
+        apikey=os.environ["VYDEVICE_APIKEY"],
+        port=int(os.environ.get("VYDEVICE_PORT", "443")),
+        protocol=os.environ.get("VYDEVICE_PROTOCOL", "https"),
+        verify=os.environ.get("VYDEVICE_VERIFY_SSL", "true").lower() == "true",
+        timeout=60,
+    )
+
+
+def main() -> None:
+    device = make_device()
+
+    # Retrieve the running configuration for the system tree.
+    pprint.pprint(device.retrieve_show_config(path=["system"]))
+
+    # Configure a dummy interface, read it back, then delete it.
+    pprint.pprint(
+        device.configure_set(
+            path=["interfaces", "dummy", "dum1", "address", "192.168.56.100/24"]
+        )
+    )
+    pprint.pprint(
+        device.retrieve_return_values(
+            path=["interfaces", "dummy", "dum1", "address"]
+        )
+    )
+    pprint.pprint(device.configure_delete(path=["interfaces", "dummy", "dum1"]))
+
+    # Generate a one-shot SSH client key.
+    randstring = "".join(
+        random.choice(string.ascii_letters + string.digits) for _ in range(20)
+    )
+    pprint.pprint(
+        device.generate(path=["ssh", "client-key", f"/tmp/key_{randstring}"])
+    )
+
+    # Operational commands.
+    pprint.pprint(device.show(path=["system", "image"]))
+    pprint.pprint(device.reset(path=["conntrack-sync", "internal-cache"]))
+
+    # Save and reload the running configuration to/from a file on the device.
+    pprint.pprint(device.config_file_save(file="/config/test300.config"))
+    pprint.pprint(device.config_file_load(file="/config/test300.config"))
+
+    # Batch multiple configuration operations in a single request.
+    pprint.pprint(
+        device.configure_multiple_op(
+            path=[
+                {
+                    "op": "set",
+                    "path": [
+                        "interfaces", "dummy", "dum1", "address",
+                        "192.168.56.100/24",
+                    ],
+                },
+                {"op": "delete", "path": ["interfaces", "dummy", "dum1"]},
+            ]
+        )
+    )
+
+
+if __name__ == "__main__":
+    main()