You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

network_cli – Use network_cli to run command on network appliances¶

New in version 2.3.

Synopsis
Parameters
Status

Synopsis ¶

This connection plugin provides a connection to remote devices over the SSH and implements a CLI shell. This connection plugin is typically used by network devices for sending and receiving CLi commands to network devices.

Parameters ¶

Parameter	Choices/Defaults	Configuration	Comments
become boolean	Default: "no"	ini entries: [privilege_escalation] become = no env:ANSIBLE_BECOME var: ansible_become	The become option will instruct the CLI session to attempt privilege escalation on platforms that support it. Normally this means transitioning from user mode to `enable` mode in the CLI session. If become is set to True and the remote device does not support privilege escalation or the privilege has already been elevated, then this option is silently ignored Can be configured form the CLI via the `--become` or `-b` options
become_method -	Default: "sudo"	ini entries: [privilege_escalation] become_method = sudo env:ANSIBLE_BECOME_METHOD var: ansible_become_method	This option allows the become method to be specified in for handling privilege escalation. Typically the become_method value is set to `enable` but could be defined as other values.
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 boolean	Default: "no"	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. Since persistent connections such as network_cli run in background processes, the user will never be prompted. By 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 the correct terminal and cliconf plugins to communicate with the remote device
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_buffer_read_timeout float	Default: 0.1	ini entries: [persistent_connection] buffer_read_timeout = 0.1 env:ANSIBLE_PERSISTENT_BUFFER_READ_TIMEOUT var: ansible_buffer_read_timeout	Configures, in seconds, the amount of time to wait for the data to be read from Paramiko channel after the command prompt is matched. This timeout value ensures that command prompt matched is correct and there is no more data left to be received from remote host.
persistent_command_timeout integer	Default: 10	ini entries: [persistent_connection] command_timeout = 10 env:ANSIBLE_PERSISTENT_COMMAND_TIMEOUT var: ansible_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 integer	Default: 30	ini entries: [persistent_connection] connect_timeout = 30 env:ANSIBLE_PERSISTENT_CONNECT_TIMEOUT var: ansible_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 integer	Default: 22	ini entries: [defaults] remote_port = 22 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 integer	Default: 120		Sets the connection time, in seconds, for the communicating with the remote device. This timeout is used as the default timeout value for commands when issuing a command to the network CLI. If the command does not return in timeout seconds, the an error is generated.

Status ¶

Authors¶

Ansible Networking Team

Hint

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