cisco.iosxr.iosxr_netconf module – Configures NetConf sub-system service on Cisco IOS-XR devices
Note
This module is part of the cisco.iosxr collection (version 9.0.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.iosxr
.
To use it in a playbook, specify: cisco.iosxr.iosxr_netconf
.
New in cisco.iosxr 1.0.0
Synopsis
This module provides an abstraction that enables and configures the netconf system service running on Cisco IOS-XR Software. This module can be used to easily enable the Netconf API. Netconf provides a programmatic interface for working with configuration and state resources as defined in RFC 6242.
Aliases: netconf
Parameters
Parameter |
Comments |
---|---|
This argument specifies the port the netconf service should listen on for SSH connections. The default port as defined in RFC 6242 is 830. Default: |
|
netconf vrf name Default: |
|
Specifies the state of the Choices:
|
Notes
Note
This module works with connection
network_cli
. See the IOS-XR Platform Options.For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.
Examples
- name: enable netconf service on port 830
cisco.iosxr.iosxr_netconf:
listens_on: 830
state: present
- name: disable netconf service
cisco.iosxr.iosxr_netconf:
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Returns the command sent to the remote device Returned: when changed is True Sample: |