network_cli

Collection Note

This module is part of the ansible.netcommon collection. To install the collection, use:

ansible-galaxy collection install ansible.netcommon

Added in version 1.0.0.

You need further requirements to be able to use this module, see the Requirements section for details.

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.

Requirements

The following Python packages are needed on the host that executes this module:

• ansible-pylibssh if using I(ssh_type=libssh)

Parameters

Parameter	Defaults / Choices	Comments
become boolean		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 C(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 from the CLI via the C(--become) or C(-b) options. Env: ANSIBLE_BECOME
become_errors str	Default: fail Choices: ignore, warn, fail	This option determines how privilege escalation failures are handled when I(become) is enabled. When set to C(ignore), the errors are silently ignored. When set to C(warn), a warning message is displayed. The default option C(fail), triggers a failure and halts execution.
become_method string	Default: sudo	This option allows the become method to be specified in for handling privilege escalation. Typically the become_method value is set to C(enable) but could be defined as other values. Env: ANSIBLE_BECOME_METHOD
host string	Default: inventory_hostname	Specifies the remote device FQDN or IP address to establish the SSH connection to.
host_key_auto_add boolean		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. Env: ANSIBLE_HOST_KEY_AUTO_ADD
host_key_checking boolean	Default: True	Set this to "False" if you want to avoid host key checking by the underlying tools Ansible uses to connect to the host Env: ANSIBLE_HOST_KEY_CHECKING Env: ANSIBLE_SSH_HOST_KEY_CHECKING
import_modules boolean	Default: True	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 C(asynchronous mode). Note- Python 3 and Ansible 2.9.16 or greater required. Note- With Ansible 2.9.x fully qualified modules names are required in tasks. Env: ANSIBLE_NETWORK_IMPORT_MODULES
network_cli_retries integer	Default: 3	Number of attempts to connect to remote host. The delay time between the retires increases after every attempt by power of 2 in seconds till either the maximum attempts are exhausted or any of the C(persistent_command_timeout) or C(persistent_connect_timeout) timers are triggered. Env: ANSIBLE_NETWORK_CLI_RETRIES
network_os string		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 string		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	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. Env: ANSIBLE_PERSISTENT_BUFFER_READ_TIMEOUT
persistent_command_timeout int	Default: 30	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. Env: ANSIBLE_PERSISTENT_COMMAND_TIMEOUT
persistent_connect_timeout int	Default: 30	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. Env: ANSIBLE_PERSISTENT_CONNECT_TIMEOUT
persistent_log_messages boolean		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. Env: ANSIBLE_PERSISTENT_LOG_MESSAGES
port int	Default: 22	Specifies the port on the remote device that listens for connections when establishing the SSH connection. Env: ANSIBLE_REMOTE_PORT
private_key_file string		The private SSH key or certificate file used to authenticate to the remote device when first establishing the SSH connection. Env: ANSIBLE_PRIVATE_KEY_FILE
remote_user string		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 C(--user) or C(-u) options. Env: ANSIBLE_REMOTE_USER
single_user_mode boolean		This option enables caching of data fetched from the target for re-use. The cache is invalidated when the target device enters configuration mode. Applicable only for platforms where this has been implemented. Env: ANSIBLE_NETWORK_SINGLE_USER_MODE Version Added: 2.0.0
ssh_type string	Default: auto Choices: libssh, paramiko, auto	The python package that will be used by the C(network_cli) connection plugin to create a SSH connection to remote host. I(libssh) will use the ansible-pylibssh package, which needs to be installed in order to work. I(paramiko) will instead use the paramiko package to manage the SSH connection. I(auto) will use ansible-pylibssh if that package is installed, otherwise will fallback to paramiko. Env: ANSIBLE_NETWORK_CLI_SSH_TYPE
terminal_errors str	Default: fail Choices: ignore, warn, fail	This option determines how failures while setting terminal parameters are handled. When set to C(ignore), the errors are silently ignored. When set to C(warn), a warning message is displayed. The default option C(fail), triggers a failure and halts execution. Version Added: 3.1.0
terminal_inital_prompt_newline boolean	Default: True	This boolean flag, that when set to I(True) will send newline in the response if any of values in I(terminal_initial_prompt) is matched.
terminal_initial_answer list / elements=string		The answer to reply with if the C(terminal_initial_prompt) is matched. The value can be a single answer or a list of answers for multiple terminal_initial_prompt. In case the login menu has multiple prompts the sequence of the prompt and excepted answer should be in same order and the value of I(terminal_prompt_checkall) should be set to I(True) if all the values in C(terminal_initial_prompt) are expected to be matched and set to I(False) if any one login prompt is to be matched.
terminal_initial_prompt list / elements=string		A single regex pattern or a sequence of patterns to evaluate the expected prompt at the time of initial login to the remote host.
terminal_initial_prompt_checkall boolean		By default the value is set to I(False) and any one of the prompts mentioned in C(terminal_initial_prompt) option is matched it won't check for other prompts. When set to I(True) it will check for all the prompts mentioned in C(terminal_initial_prompt) option in the given order and all the prompts should be received from remote host if not it will result in timeout.
terminal_stderr_re list / elements=dict		This option provides the regex pattern and optional flags to match the error string from the received response chunk. This option accepts C(pattern) and C(flags) keys. The value of C(pattern) is a python regex pattern to match the response and the value of C(flags) is the value accepted by I(flags) argument of I(re.compile) python method to control the way regex is matched with the response, for example I('re.I').
terminal_stdout_re list / elements=dict		A single regex pattern or a sequence of patterns along with optional flags to match the command prompt from the received response chunk. This option accepts C(pattern) and C(flags) keys. The value of C(pattern) is a python regex pattern to match the response and the value of C(flags) is the value accepted by I(flags) argument of I(re.compile) python method to control the way regex is matched with the response, for example I('re.I').

Authors

• Ansible Networking Team (@ansible-Network)