netconf_rpc – Execute operations on NETCONF enabled network devices¶
New in version 2.6.
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 execute NETCONF RPC requests as defined by IETF RFC standards as well as proprietary requests.
Requirements¶
The below requirements are needed on the host that executes this module.
- ncclient (>=v0.5.2)
- jxmlease
Parameters¶
Notes¶
Note
- This module requires the NETCONF system service be enabled on the remote device being managed.
- This module supports the use of connection=netconf
- To execute get-config,getoredit-configrequests it is recommended to use the Ansible netconf_get and netconf_config modules.
- This module is supported on ansible_network_osnetwork platforms. See the Network Platform Options for details.
Examples¶
- name: lock candidate
  netconf_rpc:
    rpc: lock
    content:
      target:
        candidate:
- name: unlock candidate
  netconf_rpc:
    rpc: unlock
    xmlns: "urn:ietf:params:xml:ns:netconf:base:1.0"
    content: "{'target': {'candidate': None}}"
- name: discard changes
  netconf_rpc:
    rpc: discard-changes
- name: get-schema
  netconf_rpc:
    rpc: get-schema
    xmlns: urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring
    content:
      identifier: ietf-netconf
      version: "2011-06-01"
- name: copy running to startup
  netconf_rpc:
    rpc: copy-config
    content:
      source:
        running:
      target:
        startup:
- name: get schema list with JSON output
  netconf_rpc:
    rpc: get
    content: |
      <filter>
        <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
          <schemas/>
        </netconf-state>
      </filter>
    display: json
- name: get schema using XML request
  netconf_rpc:
    rpc: "get-schema"
    xmlns: "urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring"
    content: |
      <identifier>ietf-netconf-monitoring</identifier>
      <version>2010-10-04</version>
    display: json
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]
Red Hat Support¶
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
Authors¶
- Ganesh Nalawade (@ganeshrn)
- Sven Wisotzky (@wisotzky)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
