Try SpotterFetch configuration/state data from NETCONF enabled network devices.
| "added in version" 1.0.0 of ansible.netcommon"
Authors: Ganesh Nalawade (@ganeshrn), Sven Wisotzky (@wisotzky)
Install with ansible-galaxy collection install ansible.netcommon:==3.1.3
collections:
- name: ansible.netcommon
version: 3.1.3NETCONF is a network management protocol developed and standardized by the IETF. It is documented in RFC 6241.
This module allows the user to fetch configuration and state data from NETCONF enabled network devices.
- name: Get running configuration and state data ansible.netcommon.netconf_get:
- name: Get configuration and state data from startup datastore
ansible.netcommon.netconf_get:
source: startup
- name: Get system configuration data from running datastore state (junos)
ansible.netcommon.netconf_get:
source: running
filter: <configuration><system></system></configuration>
- name: Get configuration and state data in JSON format
ansible.netcommon.netconf_get:
display: json
- name: get schema list using subtree w/ namespaces
ansible.netcommon.netconf_get:
display: json
filter: <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring"><schemas><schema/></schemas></netconf-state>
lock: never
- name: get schema list using xpath
ansible.netcommon.netconf_get:
display: xml
filter: /netconf-state/schemas/schema
- name: get interface configuration with filter (iosxr)
ansible.netcommon.netconf_get:
display: pretty
filter: <interface-configurations xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg"></interface-configurations>
lock: if-supported
- name: Get system configuration data from running datastore state (junos)
ansible.netcommon.netconf_get:
source: running
filter: <configuration><system></system></configuration>
lock: if-supported
- name: Get complete configuration data from running datastore (SROS)
ansible.netcommon.netconf_get:
source: running
filter: <configure xmlns="urn:nokia.com:sros:ns:yang:sr:conf"/>
- name: Get complete state data (SROS)
ansible.netcommon.netconf_get:
filter: <state xmlns="urn:nokia.com:sros:ns:yang:sr:state"/>
- name: "get configuration with json filter string and native output (using xmltodict)"
netconf_get:
filter: |
{
"interface-configurations": {
"@xmlns": "http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg",
"interface-configuration": null
}
}
display: native
- name: Define the Cisco IOSXR interface filter
set_fact:
filter:
interface-configurations:
"@xmlns": "http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg"
interface-configuration: null
- name: "get configuration with native filter type using set_facts"
ansible.netcommon.netconf_get:
filter: "{{ filter }}"
display: native
register: result
- name: "get configuration with direct native filter type"
ansible.netcommon.netconf_get:
filter: {
"interface-configurations": {
"@xmlns": "http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg",
"interface-configuration": null
}
}
display: native
register: result
# Make a round-trip interface description change, diff the before and after
# this demonstrates the use of the native display format and several utilities
# from the ansible.utils collection
- name: Define the openconfig interface filter
set_fact:
filter:
interfaces:
"@xmlns": "http://openconfig.net/yang/interfaces"
interface:
name: Ethernet2
- name: Get the pre-change config using the filter
ansible.netcommon.netconf_get:
source: running
filter: "{{ filter }}"
display: native
register: pre
- name: Update the description
ansible.utils.update_fact:
updates:
- path: pre.output.data.interfaces.interface.config.description
value: "Configured by ansible {{ 100 | random }}"
register: updated
- name: Apply the new configuration
ansible.netcommon.netconf_config:
content:
config:
interfaces: "{{ updated.pre.output.data.interfaces }}"
- name: Get the post-change config using the filter
ansible.netcommon.netconf_get:
source: running
filter: "{{ filter }}"
display: native
register: post
- name: Show the differences between the pre and post configurations
ansible.utils.fact_diff:
before: "{{ pre.output.data|ansible.utils.to_paths }}"
after: "{{ post.output.data|ansible.utils.to_paths }}"
lock:
choices:
- never
- always
- if-supported
default: never
description:
- Instructs the module to explicitly lock the datastore specified as C(source). If
no I(source) is defined, the I(running) datastore will be locked. By setting the
option value I(always) is will explicitly lock the datastore mentioned in C(source)
option. By setting the option value I(never) it will not lock the C(source) datastore.
The value I(if-supported) allows better interworking with NETCONF servers, which
do not support the (un)lock operation for all supported datastores.
type: str
filter:
description:
- This argument specifies the string which acts as a filter to restrict the portions
of the data to be are retrieved from the remote device. If this option is not specified
entire configuration or state data is returned in result depending on the value
of C(source) option. The C(filter) value can be either XML string or XPath or JSON
string or native python dictionary, if the filter is in XPath format the NETCONF
server running on remote host should support xpath capability else it will result
in an error. If the filter is in JSON format the xmltodict library should be installed
on the control node for JSON to XML conversion.
type: raw
source:
choices:
- running
- candidate
- startup
description:
- This argument specifies the datastore from which configuration data should be fetched.
Valid values are I(running), I(candidate) and I(startup). If the C(source) value
is not set both configuration and state information are returned in response from
running datastore.
type: str
display:
choices:
- json
- pretty
- xml
- native
description:
- Encoding scheme to use when serializing output from the device. The option I(json)
will serialize the output as JSON data. If the option value is I(json) it requires
jxmlease to be installed on control node. The option I(pretty) is similar to received
XML response but is using human readable format (spaces, new lines). The option
value I(xml) is similar to received XML response but removes all XML namespaces.
type: str
output:
contains:
formatted_output:
description:
- Contains formatted response received from remote host as per the value in
display format.
type: str
description: Based on the value of display option will return either the set of
transformed XML to JSON format from the RPC response with type dict or pretty
XML string response (human-readable) or response with namespace removed from XML
string.
returned: If the display format is selected as I(json) it is returned as dict type
and the conversion is done using jxmlease python library. If the display format
is selected as I(native) it is returned as dict type and the conversion is done
using xmltodict python library. If the display format is xml or pretty it is returned
as a string apart from low-level errors (such as action plugin).
type: complex
stdout:
description: The raw XML string containing configuration or state data received
from the underlying ncclient library.
returned: always apart from low-level errors (such as action plugin)
sample: '...'
type: str
stdout_lines:
description: The value of stdout split into a list
returned: always apart from low-level errors (such as action plugin)
sample:
- '...'
- '...'
type: list