W3cubDocs

/Ansible 2.10

community.network.nso_query – Query data from Cisco NSO.

Note

This plugin is part of the community.network collection.

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.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
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
    Choices:
  • no ←
  • yes
When set to true, validates the SSL certificate of NSO when using SSL
xpath
string / required
XPath selection relative to the root.

Examples

- name: Select device name and description
  community.network.nso_query:
    url: http://localhost:8080/jsonrpc
    username: username
    password: password
    xpath: /ncs:devices/device
    fields:
    - name
    - description

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/community/network/nso_query_module.html