Documentation

netconf_config - netconf device configuration

New in version 2.2.

Synopsis

  • Netconf 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.

Options

parameter required default choices comments
allow_agent
(added in 2.3)
no True
if true, enables querying SSH agent (if found) for keys
if false, disables querying the SSH agent for ssh keys
host
yes
the hostname or ip address of the netconf device
hostkey_verify
no True
if true, the ssh host key of the device must match a ssh key present on the host
if false, the ssh host key of the device is not checked
look_for_keys
(added in 2.3)
no True
if true, enables looking in the usual locations for ssh keys (e.g. ~/.ssh/id_*)
if false, disables looking for ssh keys
password
yes
password of the user to authenticate with
port
no 830
the netconf port
username
yes
the username to authenticate with
xml
yes
the XML content to send to the device

Examples

- name: set ntp server in the device
  netconf_config:
    host: 10.0.0.1
    username: admin
    password: admin
    xml: |
        <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
  netconf_config:
    host: 10.0.0.1
    username: admin
    password: admin
    xml: |
        <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>

Return Values

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

name description returned type sample
server_capabilities list of capabilities of the server success list of strings ['urn:ietf:params:netconf:base:1.1', 'urn:ietf:params:netconf:capability:confirmed-commit:1.0', 'urn:ietf:params:netconf:capability:candidate:1.0']


Notes

Note

  • This module supports devices with and without the the candidate and confirmed-commit capabilities. It always use the safer feature.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.