W3cubDocs

/Ansible 2.10

community.network.nso_action – Executes Cisco NSO actions and verifies output.

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

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

Examples

- name: Sync NSO device
  community.network.nso_action:
    url: http://localhost:8080/jsonrpc
    username: username
    password: password
    path: /ncs:devices/device{ce0}/sync-from
    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/community/network/nso_action_module.html