cisco.nso.nso_query – Query data from Cisco NSO.
Note
This plugin is part of the cisco.nso collection (version 1.0.2).
To install it use: ansible-galaxy collection install cisco.nso.
To use it in a playbook, specify: cisco.nso.nso_query.
Synopsis
- This module provides support for querying data from Cisco NSO using XPath.
Requirements
The below requirements are needed on the host that executes this module.
- Cisco NSO version 3.4 or higher.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| fields
list / elements=string / required
|
List of fields to select from matching nodes.
|
|
| password
string / required
|
NSO password
|
|
| timeout
integer
|
Default:
300
|
JSON-RPC request timeout in seconds
|
| url
string / required
|
NSO JSON-RPC URL, http://localhost:8080/jsonrpc
|
|
| username
string / required
|
NSO username
|
|
| validate_certs
boolean
|
|
When set to true, validates the SSL certificate of NSO when using SSL
|
| xpath
string / required
|
XPath selection relative to the root.
|
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: QUERY DEVICES DISPLAYING NAME AND DESCRIPTION
cisco.nso.nso_query:
url: https://10.10.20.49/jsonrpc
username: developer
password: C1sco12345
xpath: /ncs:devices/device
fields:
- name
- description
register: nso_query_result
- name: DISPLAY NSO_QUERY RESULT
debug:
var: nso_query_result
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| output
list / elements=string
|
success |
Value of matching nodes
|
Authors
- Claes Nästén (@cnasten)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/nso/nso_query_module.html