New in version 2.6.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
content - | This argument specifies the optional request content (all RPC attributes). The content value can either be provided as XML formatted string or as dictionary. | |
display - |
| Encoding scheme to use when serializing output from the device. The option json will serialize the output as JSON data. If the option value is json it requires jxmlease to be installed on control node. The option pretty is similar to received XML response but is using human readable format (spaces, new lines). The option value xml is similar to received XML response but removes all XML namespaces. |
rpc - | This argument specifies the request (name of the operation) to be executed on the remote NETCONF enabled device. | |
xmlns - | NETCONF operations not defined in rfc6241 typically require the appropriate XML namespace to be set. In the case the request option is not already provided in XML format, the namespace can be defined by the xmlns option. |
Note
get-config
, get
or edit-config
requests it is recommended to use the Ansible netconf_get and netconf_config modules.ansible_network_os
network platforms. See the Network Platform Options for details.- 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
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/netconf_rpc_module.html