From fe5dcd4247496b8a144f39f3b2f766e9b4400a6b Mon Sep 17 00:00:00 2001 From: hellt Date: Sun, 11 Jan 2026 18:08:39 +0100 Subject: [PATCH 1/2] added references to the tutorial --- docs/ansible/collection/cli.md | 4 ++++ docs/ansible/collection/config.md | 2 ++ docs/ansible/collection/get.md | 2 ++ docs/ansible/collection/index.md | 2 ++ .../programmability/ansible/using-nokia-srlinux-collection.md | 3 --- 5 files changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/ansible/collection/cli.md b/docs/ansible/collection/cli.md index 9128a721..473ef2ca 100644 --- a/docs/ansible/collection/cli.md +++ b/docs/ansible/collection/cli.md @@ -95,3 +95,7 @@ Common Ansible return values such as `changed`, `failed` and common SR Linux val ### result List of responses for each command using the specified output format. + +## Examples + +For examples see the [tutorial](../../tutorials/programmability/ansible/using-nokia-srlinux-collection.md). diff --git a/docs/ansible/collection/config.md b/docs/ansible/collection/config.md index bd105a9f..7d7f6a29 100644 --- a/docs/ansible/collection/config.md +++ b/docs/ansible/collection/config.md @@ -404,6 +404,8 @@ Consider the following output when a wrong path is value is used in the `update` ## Examples +Some typical use cases of this module are described below, for additional examples see the [tutorial](../../tutorials/programmability/ansible/using-nokia-srlinux-collection.md). + ### adding an interface Let's see step by step how to use the `config` module to add the `ethernet-1/1` interface to a device. diff --git a/docs/ansible/collection/get.md b/docs/ansible/collection/get.md index c7657b04..dab6816e 100644 --- a/docs/ansible/collection/get.md +++ b/docs/ansible/collection/get.md @@ -168,6 +168,8 @@ Consider the following output when a wrong path is used by the user of a module: ## Examples +Some typical use cases of this module are described below, for additional examples see the [tutorial](../../tutorials/programmability/ansible/using-nokia-srlinux-collection.md). + ### Single path The most simple example of using the `get` module is to retrieve a single path which may point to any YANG node of a chosen datastore. diff --git a/docs/ansible/collection/index.md b/docs/ansible/collection/index.md index 93f88ed2..915ebbd3 100644 --- a/docs/ansible/collection/index.md +++ b/docs/ansible/collection/index.md @@ -13,6 +13,7 @@ Ansible collection for SR Linux is identified with `nokia.srlinux` fully qualifi | **Galaxy URL** | [nokia/srlinux][coll-url] | | **Ansible Automation Platform** | [nokia/srlinux][aap-coll-url] | | **Github repository** | [nokia/srlinux-ansible-collection][repo-url] | +| **Tutorial** | [link][tutorial-link] | | **SR Linux version** | >=23.3.1[^1] | | **Python version** | >=3.10 | @@ -265,6 +266,7 @@ Create the `hosts` file as shown in the previous section and you're ready to try [jsonrpc-tutorial]: ../../tutorials/programmability/json-rpc/basics.md [ansible-httpapi-conn-plugin]: https://docs.ansible.com/ansible/latest/plugins/httpapi.html [aap-coll-url]: https://console.redhat.com/ansible/automation-hub/repo/published/nokia/srlinux/ +[tutorial-link]: ../../tutorials/programmability/ansible/using-nokia-srlinux-collection.md [^1]: `nokia.srlinux` collection requires SR Linux 23.3.1 or later. [^2]: See [`config`][config] module for details. diff --git a/docs/tutorials/programmability/ansible/using-nokia-srlinux-collection.md b/docs/tutorials/programmability/ansible/using-nokia-srlinux-collection.md index 694fce1e..6c32d89d 100644 --- a/docs/tutorials/programmability/ansible/using-nokia-srlinux-collection.md +++ b/docs/tutorials/programmability/ansible/using-nokia-srlinux-collection.md @@ -29,9 +29,6 @@ title: Using nokia.srlinux Ansible collection [^1]: the following versions have been used to create this tutorial. The newer versions might work; please pin the version to the mentioned ones if they don't. -!!!note - This is an updated tutorial that uses the new [`nokia.srlinux`][nokia-srlinux-collection] Ansible collection. The previous version of this tutorial that uses Ansible URI module is deprecated but still can be found [here](ansible-with-uri.md). - In the [JSON-RPC Basics](../json-rpc/basics.md) tutorial, we focused on the JSON-RPC interface mechanics and its capabilities. The examples we used there used a well-known `curl` command-line utility to put the focal point on the JSON-RPC itself and some automation framework. Arguably, using `curl` for network automation tasks that aren't trivial may be challenging and likely lead to hairy bash scripting. Instead, network ops teams prefer to use home-grown automation that leverages programming languages or configuration management tools like Ansible[^2] fitted to the networking purpose. From 6fb4af5249517c2d24003f8a16cee4e6b7f42bcc Mon Sep 17 00:00:00 2001 From: Roman Dodin Date: Sun, 11 Jan 2026 18:11:27 +0100 Subject: [PATCH 2/2] Update docs/ansible/collection/index.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/ansible/collection/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ansible/collection/index.md b/docs/ansible/collection/index.md index 915ebbd3..1449a8cd 100644 --- a/docs/ansible/collection/index.md +++ b/docs/ansible/collection/index.md @@ -13,7 +13,7 @@ Ansible collection for SR Linux is identified with `nokia.srlinux` fully qualifi | **Galaxy URL** | [nokia/srlinux][coll-url] | | **Ansible Automation Platform** | [nokia/srlinux][aap-coll-url] | | **Github repository** | [nokia/srlinux-ansible-collection][repo-url] | -| **Tutorial** | [link][tutorial-link] | +| **Tutorial** | [Using nokia.srlinux collection][tutorial-link] | | **SR Linux version** | >=23.3.1[^1] | | **Python version** | >=3.10 |