cisco.iosxr.iosxr_netconf – Configures NetConf sub-system service on Cisco IOS-XR devices

Note

This plugin is part of the cisco.iosxr collection (version 2.6.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 version 1.0.0: of cisco.iosxr

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.

Note

This module has a corresponding action plugin.

Parameters

Parameter

Comments

netconf_port

aliases: listens_on

integer

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: 830

netconf_vrf

aliases: vrf

string

netconf vrf name

Default: “default”

provider

dictionary

Deprecated

Starting with Ansible 2.5 we recommend using connection: network_cli.

For more information please see the Network Guide.

A dict object containing connection details.

host

string

Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.

password

string

Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.

port

integer

Specifies the port to use when building the connection to the remote device.

ssh_keyfile

path

Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.

timeout

integer

Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.

transport

string

Specifies the type of connection based transport.

Choices:

  • cli ← (default)

  • netconf

username

string

Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

state

string

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.

Choices:

  • present ← (default)

  • absent

Notes

Note

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

commands

string

Returns the command sent to the remote device

Returned: when changed is True

Sample: “ssh server netconf port 830”

Authors

  • Kedar Kekan (@kedarX)