cisco.iosxr.iosxr_netconf_module.rst

cisco.iosxr.iosxr_netconf

Configures NetConf sub-system service on Cisco IOS-XR devices

Version added: 1.0.0

• Synopsis
• Parameters
• Notes
• Examples
• Return Values
• Status

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.

Parameters

Parameter	Choices/Defaults	Comments
netconf_port integer	Default: 830	This argument specifies the port the netconf service should listen on for SSH connections. The default port as defined in RFC 6242 is 830. aliases: listens_on
netconf_vrf string	Default: "default"	netconf vrf name aliases: vrf
state string	Choices: present ← absent	Specifies the state of the iosxr_netconf resource on the remote device. If the state argument is set to present the netconf service will be configured. If the state argument is set to absent the netconf service will be removed from the configuration.

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.

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	Returned	Description
commands string	when changed is True	Returns the command sent to the remote device Sample: ssh server netconf port 830

Status

Authors

• Kedar Kekan (@kedarX)