cisco.nso.nso_show – Displays data from Cisco NSO.
Note
This plugin is part of the cisco.nso collection (version 1.0.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.nso
.
To use it in a playbook, specify: cisco.nso.nso_show
.
Requirements
The below requirements are needed on the host that executes this module.
Cisco NSO version 3.4.12 or higher, 4.1.9 or higher, 4.2.6 or higher, 4.3.7 or higher, 4.4.5 or higher, 4.5 or higher.
Parameters
Parameter |
Comments |
---|---|
Controls whether or not operational data is included in the result. Choices:
|
|
NSO password |
|
Path to NSO data. |
|
JSON-RPC request timeout in seconds Default: 300 |
|
NSO JSON-RPC URL, http://localhost:8080/jsonrpc |
|
NSO username |
|
When set to true, validates the SSL certificate of NSO when using SSL Choices:
|
See Also
See also
- Cisco DevNet NSO Sandbox
Provides a reservable pod with NSO, virtual network topology simulated with Cisco CML and a Linux host running Ansible
- NSO Developer Resources on DevNet
Documentation for getting started using NSO
- NSO Developer Hub
Collaboration community portal for NSO developers
- NSO Developer Github
Code for NSO on Github
Examples
- name: DISPLAY DEVICE INCLUDING OPERATIONAL DATA
cisco.nso.nso_show:
url: https://10.10.20.49/jsonrpc
username: developer
password: C1sco12345
path: /ncs:devices/device{dist-rtr01}
operational: true
register: result
- name: Display the result
debug:
var: result
- name: DISPLAY INTERFACES
cisco.nso.nso_show:
url: "https://10.10.20.49/jsonrpc"
username: developer
password: C1sco12345
path: /ncs:devices/device{dist-rtr01}/config/interface
operational: true
register: result
- name: Display the result
debug:
var: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Configuration Returned: success |
Authors
Claes Nästén (@cnasten)