Try Spotternetconf device configuration
| "added in version" 1.0.0 of ansible.netcommon"
Authors: Leandro Lisboa Penz (@lpenz), Ganesh Nalawade (@ganeshrn)
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 send a configuration XML file to a netconf device, and detects if there was a configuration change.
- name: use lookup filter to provide xml configuration
ansible.netcommon.netconf_config:
content: "{{ lookup('file', './config.xml') }}"
- name: set ntp server in the device
ansible.netcommon.netconf_config:
content: |
<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">
<system xmlns="urn:ietf:params:xml:ns:yang:ietf-system">
<ntp>
<enabled>true</enabled>
<server>
<name>ntp1</name>
<udp><address>127.0.0.1</address></udp>
</server>
</ntp>
</system>
</config>
- name: wipe ntp configuration
ansible.netcommon.netconf_config:
content: |
<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">
<system xmlns="urn:ietf:params:xml:ns:yang:ietf-system">
<ntp>
<enabled>false</enabled>
<server operation="remove">
<name>ntp1</name>
</server>
</ntp>
</system>
</config>
- name: configure interface while providing different private key file path (for connection=netconf)
ansible.netcommon.netconf_config:
backup: yes
register: backup_junos_location
vars:
ansible_private_key_file: /home/admin/.ssh/newprivatekeyfile
- name: configurable backup path
ansible.netcommon.netconf_config:
backup: yes
backup_options:
filename: backup.cfg
dir_path: /home/user
- name: "configure using direct native format configuration (cisco iosxr)"
ansible.netcommon.netconf_config:
format: json
content: {
"config": {
"interface-configurations": {
"@xmlns": "http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg",
"interface-configuration": {
"active": "act",
"description": "test for ansible Loopback999",
"interface-name": "Loopback999"
}
}
}
}
get_filter: {
"interface-configurations": {
"@xmlns": "http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg",
"interface-configuration": null
}
}
- name: "configure using json string format configuration (cisco iosxr)"
ansible.netcommon.netconf_config:
format: json
content: |
{
"config": {
"interface-configurations": {
"@xmlns": "http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg",
"interface-configuration": {
"active": "act",
"description": "test for ansible Loopback999",
"interface-name": "Loopback999"
}
}
}
}
get_filter: |
{
"interface-configurations": {
"@xmlns": "http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg",
"interface-configuration": null
}
}
# 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: always
description:
- Instructs the module to explicitly lock the datastore specified as C(target). By
setting the option value I(always) is will explicitly lock the datastore mentioned
in C(target) option. It the value is I(never) it will not lock the C(target) datastore.
The value I(if-supported) lock the C(target) datastore only if it is supported by
the remote Netconf server.
type: str
save:
default: false
description:
- The C(save) argument instructs the module to save the configuration in C(target)
datastore to the startup-config if changed and if :startup capability is supported
by Netconf server.
type: bool
backup:
default: false
description:
- This argument will cause the module to create a full backup of the current C(running-config)
from the remote device before any changes are made. If the C(backup_options) value
is not given, the backup file is written to the C(backup) folder in the playbook
root directory or role root directory, if playbook is part of an ansible role. If
the directory does not exist, it is created.
type: bool
commit:
default: true
description:
- This boolean flag controls if the configuration changes should be committed or not
after editing the candidate datastore. This option is supported only if remote Netconf
server supports :candidate capability. If the value is set to I(False) commit won't
be issued after edit-config operation and user needs to handle commit or discard-changes
explicitly.
type: bool
delete:
default: false
description:
- It instructs the module to delete the configuration from value mentioned in C(target)
datastore.
type: bool
format:
choices:
- xml
- text
- json
description:
- The format of the configuration provided as value of C(content).
- In case of json string format it will be converted to the corresponding xml string
using xmltodict library before pushing onto the remote host.
- In case of I(text) format of the configuration should be supported by remote Netconf
server.
- If the value of C(format) options is not given it tries to guess the data format
of C(content) option as one of I(xml) or I(json) or I(text).
- If the data format is not identified it is set to I(xml) by default.
type: str
target:
aliases:
- datastore
choices:
- auto
- candidate
- running
default: auto
description: Name of the configuration datastore to be edited. - auto, uses candidate
and fallback to running - candidate, edit <candidate/> datastore and then commit
- running, edit <running/> datastore directly
type: str
confirm:
default: 0
description:
- This argument will configure a timeout value for the commit to be confirmed before
it is automatically rolled back. If the C(confirm_commit) argument is set to False,
this argument is silently ignored. If the value of this argument is set to 0, the
commit is confirmed immediately. The remote host MUST support :candidate and :confirmed-commit
capability for this option to .
type: int
content:
aliases:
- xml
description:
- The configuration data as defined by the device's data models, the value can be
either in xml string format or text format or python dictionary representation of
JSON format.
- In case of json string format it will be converted to the corresponding xml string
using xmltodict library before pushing onto the remote host.
- In case the value of this option isn I(text) format the format should be supported
by remote Netconf server.
- If the value of C(content) option is in I(xml) format in that case the xml value
should have I(config) as root tag.
type: raw
validate:
default: false
description:
- This boolean flag if set validates the content of datastore given in C(target) option.
For this option to work remote Netconf server should support :validate capability.
type: bool
get_filter:
description:
- This argument specifies the XML string which acts as a filter to restrict the portions
of the data retrieved from the remote device when comparing the before and after
state of the device following calls to edit_config. When not specified, the entire
configuration or state data is returned for comparison depending on the value of
C(source) option. The C(get_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.
type: raw
error_option:
choices:
- stop-on-error
- continue-on-error
- rollback-on-error
default: stop-on-error
description:
- This option controls the netconf server action after an error occurs while editing
the configuration.
- If I(error_option=stop-on-error), abort the config edit on first error.
- If I(error_option=continue-on-error), continue to process configuration data on
error. The error is recorded and negative response is generated if any errors occur.
- If I(error_option=rollback-on-error), rollback to the original configuration if
any error occurs. This requires the remote Netconf server to support the I(error_option=rollback-on-error)
capability.
type: str
backup_options:
description:
- This is a dict object containing configurable options related to backup file path.
The value of this option is read only when C(backup) is set to I(yes), if C(backup)
is set to I(no) this option will be silently ignored.
suboptions:
dir_path:
description:
- This option provides the path ending with directory name in which the backup
configuration file will be stored. If the directory does not exist it will be
first created and the filename is either the value of C(filename) or default
filename as described in C(filename) options description. If the path value
is not given in that case a I(backup) directory will be created in the current
working directory and backup configuration will be copied in C(filename) within
I(backup) directory.
type: path
filename:
description:
- The filename to be used to store the backup configuration. If the filename is
not given it will be generated based on the hostname, current time and date
in format defined by <hostname>_config.<current-date>@<current-time>
type: str
type: dict
confirm_commit:
default: false
description:
- This argument will execute commit operation on remote device. It can be used to
confirm a previous commit.
type: bool
source_datastore:
aliases:
- source
description:
- Name of the configuration datastore to use as the source to copy the configuration
to the datastore mentioned by C(target) option. The values can be either I(running),
I(candidate), I(startup) or a remote URL
type: str
default_operation:
choices:
- merge
- replace
- none
description:
- The default operation for <edit-config> rpc, valid values are I(merge), I(replace)
and I(none). If the default value is merge, the configuration data in the C(content)
option is merged at the corresponding level in the C(target) datastore. If the value
is replace the data in the C(content) option completely replaces the configuration
in the C(target) datastore. If the value is none the C(target) datastore is unaffected
by the configuration in the config option, unless and until the incoming configuration
data uses the C(operation) operation to request a different operation.
type: str
backup_path:
description: The full path to the backup file
returned: when backup is yes
sample: /playbooks/ansible/backup/config.2016-07-16@22:28:34
type: str
diff:
description: If --diff option in enabled while running, the before and after configuration
change are returned as part of before and after key.
returned: when diff is enabled
sample:
after: <rpc-reply> <data> <configuration> <version>17.3R1.10</version>...<--snip-->
before: <rpc-reply> <data> <configuration> <version>17.3R1.10</version>...<--snip-->
type: dict
server_capabilities:
description: list of capabilities of the server
returned: success
sample:
- urn:ietf:params:netconf:base:1.1
- urn:ietf:params:netconf:capability:confirmed-commit:1.0
- urn:ietf:params:netconf:capability:candidate:1.0
type: list