nso_query - Query data from Cisco NSO.¶

New in version 2.5.

Synopsis
- Requirements
Parameters
Examples
Return Values
Status
Maintenance
- Author

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 required		List of fields to select from matching nodes.
password required		NSO password
timeout (added in 2.6)	Default: 300	JSON-RPC request timeout in seconds
url required		NSO JSON-RPC URL, http://localhost:8080/jsonrpc
username required		NSO username
xpath required		XPath selection relative to the root.

Examples ¶

- name: Select device name and description
  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	success	Value of matching nodes

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

This module is flagged as certified which means that it is maintained by an Ansible Partner. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by an Ansible Partner, see here.

Author ¶

Claes Nästén (@cnasten)

Hint

If you notice any issues in this documentation you can edit this document to improve it.