community.network.nso_verify – Verifies Cisco NSO configuration.
community.network.nso_verify – Verifies Cisco NSO configuration.
Note
This plugin is part of the community.network collection (version 1.3.0).
To install it use: ansible-galaxy collection install community.network
.
To use it in a playbook, specify: community.network.nso_verify
.
Synopsis
- This module provides support for verifying Cisco NSO configuration is in compliance with specified values.
Requirements
The below requirements are needed on the host that executes this module.
- Cisco NSO version 3.4.12 or higher, 4.2.7 or higher, 4.3.8 or higher, 4.4.3 or higher, 4.5 or higher.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
data string / required |
NSO data in format as | |
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 |
Examples
- name: Verify interface is up
nso_config:
url: http://localhost:8080/jsonrpc
username: username
password: password
data:
ncs:devices:
device:
- name: ce0
live-status:
interfaces:
interface:
- name: GigabitEthernet0/12
- state: Up
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
violations complex |
failed |
List of value violations
Sample: [{'expected-value': 'CE0 example', 'path': '/ncs:devices/device{ce0}/description', 'value': None}] | |
expected-value string |
always |
Expected value of path
| |
path string |
always |
Path to the value in violation
| |
value string |
always |
Current value of path
|
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_verify_module.html