cisco.nso.nso_action – Executes Cisco NSO actions and verifies output.

cisco.nso.nso_action – Executes Cisco NSO actions and verifies output.

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_action.

• Synopsis
• Requirements
• Parameters
• See Also
• Examples
• Return Values

Synopsis

• This module provides support for executing Cisco NSO actions and then verifying that the output is as expected.

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
input dictionary		NSO action parameters.
output_invalid dictionary		List of result parameter names that will cause the task to fail if they are present.
output_required dictionary		Required output parameters.
password string / required		NSO password
path string / required		Path to NSO action.
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	no ← yes	When set to true, validates the SSL certificate of NSO when using SSL
validate_strict boolean	no yes	If set to true, the task will fail if any output parameters not in output_required is present in the output.

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: Sync NSO device
  cisco.nso.nso_action:
    url: https://10.10.20.49/jsonrpc
    username: developer
    password: C1sco12345
    path: /ncs:devices/device{dist-rtr01}/sync-from
    input: {}

- name: Check device sync
  cisco.nso.nso_action:
    url: https://10.10.20.49/jsonrpc
    username: developer
    password: C1sco12345
    path: /ncs:devices/check-sync
    input: {}

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
output dictionary	success	Action output Sample: {'result': True}

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_action_module.html