Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/ansible/collection/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 2 additions & 0 deletions docs/ansible/collection/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions docs/ansible/collection/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions docs/ansible/collection/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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** | [Using nokia.srlinux collection][tutorial-link] |
| **SR Linux version** | >=23.3.1[^1] |
| **Python version** | >=3.10 |

Expand Down Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down