Documentation

netconf - Provides a persistent connection using the netconf protocol

New in version 2.3.

Synopsis

  • This connection plugin provides a connection to remote devices over the SSH NETCONF subsystem. This connection plugin is typically used by network devices for sending and receiving RPC calls over NETCONF.
  • Note this connection plugin requires ncclient to be installed on the local Ansible controller.

Requirements

The below requirements are needed on the local master node that executes this connection.

  • ncclient

Parameters

Parameter Choices/Defaults Configuration Comments
host Default:
inventory_hostname
var: ansible_host
Specifies the remote device FQDN or IP address to establish the SSH connection to.
host_key_auto_add
bool
    Choices:
  • no ←
  • yes
ini entries:

[paramiko_connection ]
host_key_auto_add = no

env:ANSIBLE_HOST_KEY_AUTO_ADD
By default, Ansible will prompt the user before adding SSH keys to the known hosts file. Enabling this option, unknown host keys will automatically be added to the known hosts file.
Be sure to fully understand the security implications of enabling this option on production systems as it could create a security vulnerability.
network_os
var: ansible_network_os
Configures the device platform network operating system. This value is used to load a device specific netconf plugin. If this option is not configured, then the default netconf plugin will be used.
password
var: ansible_password
var: ansible_ssh_pass
Configures the user password used to authenticate to the remote device when first establishing the SSH connection.
persistent_command_timeout
int
Default:
10
ini entries:

[persistent_connection ]
command_timeout = 10

env:ANSIBLE_PERSISTENT_COMMAND_TIMEOUT
Configures, in seconds, the amount of time to wait for a command to return from the remote device. If this timer is exceeded before the command returns, the connection plugin will raise an exception and close
persistent_connect_timeout
int
Default:
30
ini entries:

[persistent_connection ]
connect_timeout = 30

env:ANSIBLE_PERSISTENT_CONNECT_TIMEOUT
Configures, in seconds, the amount of time to wait when trying to initially establish a persistent connection. If this value expires before the connection to the remote device is completed, the connection will fail
port
int
Default:
830
ini entries:

[defaults ]
remote_port = 830

env:ANSIBLE_REMOTE_PORT
var: ansible_port
Specifies the port on the remote device to listening for connections when establishing the SSH connection.
private_key_file
ini entries:

[defaults ]
private_key_file = VALUE

env:ANSIBLE_PRIVATE_KEY_FILE
var: ansible_private_key_file
The private SSH key or certificate file used to to authenticate to the remote device when first establishing the SSH connection.
remote_user
ini entries:

[defaults ]
remote_user = VALUE

env:ANSIBLE_REMOTE_USER
var: ansible_user
The username used to authenticate to the remote device when the SSH connection is first established. If the remote_user is not specified, the connection will use the username of the logged in user.
Can be configured form the CLI via the --user or -u options
timeout
int
Default:
120
Sets the connection time for the communicating with the remote device. This timeout is used as the default timeout value when awaiting a response after issuing a call to a RPC. If the RPC does not return in timeout seconds, an error is generated.

Status

Author

  • Ansible Networking Team

Hint

If you notice any issues in this documentation you can edit this document to improve it.