ansible.netcommon.netconf connection – Provides a persistent connection using the netconf protocol
Note
This connection plugin is part of the ansible.netcommon collection (version 5.3.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 ansible.netcommon.
You need further requirements to be able to use this connection plugin,
see Requirements for details.
To use it in a playbook, specify: ansible.netcommon.netconf.
New in ansible.netcommon 1.0.0
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 controller node that executes this connection.
ncclient
Parameters
Parameter |
Comments |
|---|---|
Specifies the remote device FQDN or IP address to establish the SSH connection to. Default: Configuration:
|
|
Set this to “False” if you want to avoid host key checking by the underlying tools Ansible uses to connect to the host Choices:
Configuration:
|
|
Reduce CPU usage and network module execution time by enabling direct execution. Instead of the module being packaged and executed by the shell, it will be directly executed by the Ansible control node using the same python interpreter as the Ansible process. Note- Incompatible with Choices:
Configuration:
|
|
Enables looking for ssh keys in the usual locations for ssh keys (e.g. :file:`~/.ssh/id_*`). Choices:
Configuration:
|
|
This variable is used to enable bastion/jump host with netconf connection. If set to True the bastion/jump host ssh settings should be present in ~/.ssh/config file, alternatively it can be set to custom ssh configuration file path to read the bastion/jump host settings. Configuration:
|
|
Configures the device platform network operating system. This value is used to load a device specific netconf plugin. If this option is not configured (or set to Configuration:
|
|
Configures the user password used to authenticate to the remote device when first establishing the SSH connection. Configuration:
|
|
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. Default: Configuration:
|
|
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. Default: Configuration:
|
|
This flag will enable logging the command executed and response received from target device in the ansible log file. For this option to work ‘log_path’ ansible configuration option is required to be set to a file path with write access. Be sure to fully understand the security implications of enabling this option as it could create a security vulnerability by logging sensitive information in log file. Choices:
Configuration:
|
|
Specifies the port on the remote device that listens for connections when establishing the SSH connection. Default: Configuration:
|
|
The private SSH key or certificate file used to authenticate to the remote device when first establishing the SSH connection. Configuration:
|
|
Proxy information for running the connection via a jumphost. This requires ncclient >= 0.6.10 to be installed on the controller. Default: Configuration:
|
|
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 from the CLI via the Configuration:
|